home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2001 May / SGI Freeware 2001 May - Disc 1.iso / dist / fw_teTeX.idb / usr / freeware / info / kpathsea.info.z / kpathsea.info (.txt)
GNU Info File  |  2001-01-10  |  188KB  |  3,482 lines
  1. This is Info file kpathsea.info, produced by Makeinfo version 1.68 from
  2. the input file kpathsea.texi.
  3. INFO-DIR-SECTION TeX
  4. START-INFO-DIR-ENTRY
  5. * Kpathsea: (kpathsea).                       File lookup along search paths.
  6. * kpsewhich: (kpathsea)Invoking kpsewhich.    TeX file searching.
  7. * mktexmf: (kpathsea)mktex scripts.           MF source generation.
  8. * mktexpk: (kpathsea)mktex scripts.           PK bitmap generation.
  9. * mktextex: (kpathsea)mktex scripts.          TeX source generation.
  10. * mktextfm: (kpathsea)mktex scripts.          TeX font metric generation.
  11. * mktexlsr: (kpathsea)Filename database.      Update ls-R.
  12. END-INFO-DIR-ENTRY
  13.   This file documents the Kpathsea library for path searching.
  14.   Copyright (C) 1993, 94, 95, 96, 97 K. Berry & O. Weber.
  15.   Permission is granted to make and distribute verbatim copies of this
  16. manual provided the copyright notice and this permission notice are
  17. preserved on all copies.
  18.   Permission is granted to copy and distribute modified versions of this
  19. manual under the conditions for verbatim copying, provided that the
  20. entire resulting derived work is distributed under the terms of a
  21. permission notice identical to this one.
  22.   Permission is granted to copy and distribute translations of this
  23. manual into another language, under the above conditions for modified
  24. versions, except that this permission notice may be stated in a
  25. translation approved by the Free Software Foundation.
  26. File: kpathsea.info,  Node: Top,  Next: Introduction,  Up: (dir)
  27. Kpathsea library
  28. ****************
  29.   This manual documents how to install and use the Kpathsea library for
  30. filename lookup.  It corresponds to version 3.3.1, released in
  31. May 1999.
  32. * Menu:
  33. * Introduction::                Overview.
  34. * Installation::                Compilation, installation, and bug reporting.
  35. * Path searching::              How filename lookups work.
  36. * TeX support::                 Special support for TeX-related file lookups.
  37. * Programming::                 How to use Kpathsea features in your program.
  38. * Index::                       General index.
  39. File: kpathsea.info,  Node: Introduction,  Next: Installation,  Prev: Top,  Up: Top
  40. Introduction
  41. ************
  42.   This manual corresponds to version 3.3.1 of the Kpathsea library,
  43. released in May 1999.
  44.   The library's fundamental purpose is to return a filename from a list
  45. of directories specified by the user, similar to what shells do when
  46. looking up program names to execute.
  47.   The following software, all of which we maintain, uses this library:
  48.    * Dviljk (see the `dvilj' man page)
  49.    * Dvipsk (*note Introduction: (dvips)Top.)
  50.    * GNU font utilities (*note Introduction: (fontu)Top.)
  51.    * Web2c (*note Introduction: (web2c)Top.)
  52.    * Xdvik (see the `xdvi' man page)
  53. Other software that we do not maintain also uses it.
  54.   We are still actively maintaining the library (and probably always
  55. will be, despite our hopes).  If you have comments or suggestions,
  56. please send them to us (*note Reporting bugs::.).
  57.   We distribute the library under the GNU Library General Public License
  58. (LGPL).  In short, this means if you write a program using the library,
  59. you must (offer to) distribute the source to the library, along with any
  60. changes you have made, and allow anyone to modify the library source and
  61. distribute their modifications.  It does not mean you have to distribute
  62. the source to your program, although we hope you will.  See the files
  63. `COPYING' and `COPYING.LIB' for the text of the GNU licenses.
  64.   If you know enough about TeX to be reading this manual, then you (or
  65. your institution) should consider joining the TeX Users Group (if
  66. you're already a member, great!).  TUG produces the periodical
  67. `TUGboat', sponsors an annual meeting and publishes the proceedings,
  68. and arranges courses on TeX for all levels of users throughout the
  69. world.  Anyway, here is the address:
  70.      TeX Users Group
  71.      P.O. Box 2311
  72.      Portland OR 97208-2311
  73.      USA
  74.      phone: +1 503 223-9994
  75.      fax:   +1 503 223-3960
  76.      email: <tug@tug.org>
  77. * Menu:
  78. * History::
  79. File: kpathsea.info,  Node: History,  Up: Introduction
  80. History
  81. =======
  82.   (This section is for those people who are curious about how the
  83. library came about.)  (If you like to read historical accounts of
  84. software, we urge you to seek out the GNU Autoconf manual and the
  85. "Errors of TeX" paper by Don Knuth, published in `Software--Practice and
  86. Experience' 19(7), July 1989.)
  87.   [Karl writes.]  My first ChangeLog entry for Web2c seems to be
  88. February 1990, but I may have done some work before then.  In any case,
  89. Tim Morgan and I were jointly maintaining it for a time.  (I should
  90. mention here that Tim had made Web2c into a real distribution long
  91. before I had ever used it or even heard of it, and Tom Rokicki did the
  92. original implementation.  I was using `pxp' and `pc' on VAX 11/750's
  93. and the hot new Sun 2 machines.)
  94.   It must have been later in 1990 and 1991 that I started working on
  95. `TeX for the Impatient'. Dvips, Xdvi, Web2c, and the GNU fontutils
  96. (which I was also writing at the time) all used different environment
  97. variables, and, more importantly, had different bugs in their path
  98. searching. This became extremely painful, as I was stressing everything
  99. to the limit working on the book.  I also desperately wanted to
  100. implement subdirectory searching, since I couldn't stand putting
  101. everything in one big directory, and also couldn't stand having to
  102. explicitly specify `cm', `pandora', ... in a path.
  103.   In the first incarnation, I just hacked separately on each
  104. program--that was the original subdirectory searching code in both Xdvi
  105. and Dvips, though I think Paul Vojta has completely rewritten Xdvi's
  106. support by now.  That is, I tried to go with the flow in each program,
  107. rather than changing the program's calling sequences to conform to
  108. common routines.
  109.   Then, as bugs inevitably appeared, I found I was fixing the same thing
  110. three times (Web2c and fontutils were always sharing code, since I
  111. maintained those--there was no Dvipsk or Xdvik or Dviljk at this
  112. point).  After a while, I finally started sharing source files.  They
  113. weren't yet a library, though.  I just kept things up to date with shell
  114. scripts.  (I was developing on a 386 running ISC 2.2 at the time, and so
  115. didn't have symbolic links.  An awful experience.)
  116.   The ChangeLogs for Xdvik and Dvipsk record initial releases of those
  117. distributions in May and June 1992.  I think it was because I was tired
  118. of the different configuration strategies of each program, not so much
  119. because of the path searching.  (Autoconf was being developed by David
  120. MacKenzie and others, and I was adapting it to TeX and friends.)
  121.   I started to make a separate library that other programs could link
  122. with on my birthday in April 1993, according to the ChangeLog.  I don't
  123. remember exactly why I finally took the time to make it a separate
  124. library; a conversation with david zuhn that initiated it.  Just seemed
  125. like it was time.
  126.   Dviljk got started in March 1994 after I bought a Laserjet 4.
  127. (Kpathsea work got suspended while Norm Walsh and I, with Gustaf
  128. Neumann's help, implemented a way for TeX to get at all those neat
  129. builtin LJ4 fonts ... such a treat to have something to typeset in
  130. besides Palatino!)
  131.   By spring of 1995, I had implemented just about all the path-searching
  132. features in Kpathsea that I plan to, driven beyond my initial goals by
  133. Thomas Esser and others.  I then started to integrate Web2c with
  134. Kpathsea. After the release of a stable Web2c, I hope to be able to stop
  135. development, and turn most of my attention back to making fonts for GNU.
  136. (Always assuming Micros**t hasn't completely obliterated Unix by then,
  137. or that software patents haven't stopped software development by anybody
  138. smaller than a company with a million-dollar-a-year legal budget.  Which
  139. is actually what I think is likely to happen, but that's another
  140. story...)
  141.   [Olaf writes.]  At the end of 1997, UNIX is still alive and kicking,
  142. individuals still develop software, and Web2c development still
  143. continues.  Karl had been looking for some time for someone to take up
  144. part of the burden, and I volunteered.
  145. File: kpathsea.info,  Node: Installation,  Next: Path searching,  Prev: Introduction,  Up: Top
  146. Installation
  147. ************
  148.   (A copy of this chapter is in the distribution file
  149. `kpathsea/INSTALL'.)
  150.   The procedure for Kpathsea (and Web2c, etc.) configuration and
  151. installation follows.  If you encounter trouble, see *Note Common
  152. problems::, a copy of which is in the file `kpathsea/BUGS'.
  153. * Menu:
  154. * Simple installation::      If you just want to do it.
  155. * Custom installation::      If you want to change things around.
  156. * Security::                 Who can write what files, etc.
  157. * TeX directory structure::  Managing the horde of TeX input files.
  158. * unixtex.ftp::              Getting software via FTP, on CD-ROM, or on tape.
  159. * Reporting bugs::           Where and how to report bugs.
  160. File: kpathsea.info,  Node: Simple installation,  Next: Custom installation,  Up: Installation
  161. Simple installation
  162. ===================
  163.   Installing TeX and friends for the first time can be a daunting
  164. experience.  Thus, you may prefer to skip this whole thing and just get
  165. precompiled executables: see *Note unixtex.ftp::.
  166.   This section explains what to do if you wish to take the defaults for
  167. everything, and generally to install in the simplest possible way.  Most
  168. steps here refer to corresponding subsection in the next section which
  169. explains how to override defaults and generally gives more details.
  170.   By default everything will be installed under `/usr/local' and the
  171. following discussion assumes this.  However, if you already have TeX
  172. installed, its location is used to derive the directory under which
  173. everything is to be installed.
  174.   1. Be sure you have enough disk space: approximately 8 megabytes for
  175.      the compressed archives, 15MB for sources, 50MB for compilation,
  176.      40MB for the (initial) installed system (including library files).
  177.      *Note Disk space::.
  178.   2. Retrieve these distribution archives:
  179.     `ftp://ftp.tug.org/tex/texk.tar.gz'
  180.           These are the sources, which you will be compiling.
  181.     `ftp://ftp.tug.org/tex/texklib.tar.gz'
  182.           This is a basic set of input files.  You should unpack it in
  183.           the directory `/usr/local/share'; doing so will create a
  184.           `texmf' subdirectory there.
  185.      These archives are mirrored on the CTAN hosts, in the
  186.      `systems/web2c' directory.
  187.      *Note Kpathsea application distributions::.
  188.   3. When using the default search paths, there is no need to edit any
  189.      distribution files. *Note Changing search paths::.
  190.   4. At the top level of the distribution, run `sh configure'.  (If you
  191.      have the GNU Bash shell installed, run `bash configure'.)  *Note
  192.      Running configure::.
  193.   5. `make'. *Note Running make::.  If you are using a BSD 4.4 system
  194.      such as FreeBSD or NetBSD, you may have to use GNU make (often
  195.      installed in `/usr/local/bin'), not the BSD make.
  196.   6. `make install'. *Note Installing files::.
  197.   7. `make distclean'. *Note Cleaning up::.
  198.   8. Set up a cron job to rebuild the filename database that makes
  199.      searching faster.  This line will rebuild it every midnight:
  200.           0 0 * * * cd /usr/local/share/texmf && /BINDIR/mktexlsr
  201.      *Note Filename database generation::, and *Note Filename
  202.      database::.
  203.   9. If you're installing Dvips, you also need to set up configuration
  204.      files for your printers and make any additional PostScript fonts
  205.      available.  *Note Installation: (dvips)Installation.  If you have
  206.      any color printers, see *Note Color device configuration:
  207.      (dvips)Color device configuration.
  208.  10. The first time you run a DVI driver, a bunch of PK fonts will be
  209.      built by Metafont via `mktexpk' (and added to the filename
  210.      database).  This will take some time.  Don't be alarmed; they will
  211.      created only this first time (unless something is wrong with your
  212.      path definitions).
  213.      By default, `mktexpk' will create these fonts in a hierarchy under
  214.      `/var/tmp/texfonts'; it simply assumes that `/var/tmp' exists and
  215.      is globally writable.  If you need a different arrangement, see
  216.      *Note mktex configuration::.
  217.      *Note mktex scripts::.
  218.  11. For some simple tests, try `tex story \\bye' and `latex sample2e'.
  219.      Then run `xdvi story' or `dvips sample2e' on the resulting DVI
  220.      files to preview/print the documents.  *Note Installation
  221.      testing::.
  222. File: kpathsea.info,  Node: Custom installation,  Next: Security,  Prev: Simple installation,  Up: Installation
  223. Custom installation
  224. ===================
  225.   Most sites need to modify the default installation procedure in some
  226. way, perhaps merely changing the prefix from `/usr/local', perhaps
  227. adding extra compiler or loader options to work around `configure'
  228. bugs.  This section explains how to override default choices.  For
  229. additional distribution-specific information:
  230.    * `dviljk/INSTALL'.
  231.    * *Note Installation: (dvips)Installation.
  232.    * *Note Installation: (web2c)Installation.
  233.    * `xdvik/INSTALL'.
  234.   These instructions are for Unix systems.  Other operating-system
  235. specific distributions have their own instructions.  The code base
  236. itself supports Amiga, DOS, OS/2, and VMS.
  237.   Following are the same steps as in the previous section (which
  238. describes the simplest installation), but with much more detail.
  239. * Menu:
  240. * Disk space::
  241. * Kpathsea application distributions::
  242. * Changing search paths::
  243. * Running configure::
  244. * Running make::
  245. * Installing files::
  246. * Cleaning up::
  247. * Filename database generation::
  248. * mktex scripts::
  249. * Installation testing::
  250. File: kpathsea.info,  Node: Disk space,  Next: Kpathsea application distributions,  Up: Custom installation
  251. Disk space
  252. ----------
  253.   Here is a table showing the disk space needed for each distribution
  254. (described in the next section).  The `(totals)' line reflects the
  255. `texk' source distribution and `texklib'; the individual distributions
  256. don't enter into it.  Sizes are in megabytes.  All numbers are
  257. approximate.
  258. Distribution  .tar.gz  Unpacked  Compiled  Installed  
  259. dviljk        .9       3.8                            
  260. dvipsk        .9       3.2                            
  261. xdvik         .7       2.5                            
  262. web2c         1.3      5.0                            
  263. web           1.9      6.5       -         -          
  264. texk          3.8      14.1      43.1      23.5       
  265. texklib       3.8      15.0      -         15.0       
  266. (totals)      7.6      29.1      43.1      38.5       
  267. File: kpathsea.info,  Node: Kpathsea application distributions,  Next: Changing search paths,  Prev: Disk space,  Up: Custom installation
  268. Kpathsea application distributions
  269. ----------------------------------
  270.   The archive `ftp://ftp.tug.org/tex/texk.tar.gz' contains all of the
  271. Kpathsea applications I maintain, and the library itself.  For example,
  272. since NeXT does not generally support X11, you'd probably want to skip
  273. `xdvik' (or simply remove it after unpacking `texk.tar.gz'.  If you are
  274. not interested in all of them, you can also retrieve them separately:
  275. `dviljk.tar.gz'
  276.      DVI to PCL, for LaserJet printers.
  277. `dvipsk.tar.gz'
  278.      DVI to PostScript, for previewers, printers, or PDF generation.
  279. `web2c.tar.gz'
  280.      The software needed to compile TeX and friends.
  281. `web.tar.gz'
  282.      The original WEB source files, also used in compilation.
  283. `xdvik.tar.gz'
  284.      DVI previewing under the X window system.
  285.   If you want to use the Babel LaTeX package for support of non-English
  286. typesetting, you may need to retrieve additional files.  See the file
  287. `install.txt' in the Babel distribution.
  288. File: kpathsea.info,  Node: Changing search paths,  Next: Running configure,  Prev: Kpathsea application distributions,  Up: Custom installation
  289. Changing search paths
  290. ---------------------
  291.   If the search paths for your installation differ from the standard
  292. TeX directory structure (*note Introduction: (tds)Top.), edit the file
  293. `kpathsea/texmf.in' as desired, before running `configure'.  For
  294. example, if you have all your fonts or macros in one big directory.
  295.   You may also wish to edit the file `mktex.cnf', either before or
  296. after installation, to control various aspects of `mktexpk' and
  297. friends.  *Note mktex configuration::.
  298.   You do not need to edit `texmf.in' to change the default top-level or
  299. other installation *directories* (only the paths).  You can and should
  300. do that when you run `configure' (next step).
  301.   You also do not need to edit `texmf.in' if you are willing to rely on
  302. `texmf.cnf' at runtime to define the paths, and let the compile-time
  303. default paths be incorrect.  Usually there is no harm in doing this.
  304.   The section below explains default generation in more detail.
  305. * Menu:
  306. * Default path features::
  307. * Default path generation::
  308. File: kpathsea.info,  Node: Default path features,  Next: Default path generation,  Up: Changing search paths
  309. Default path features
  310. .....................
  311.   The purpose of having all the different files described in the section
  312. above is to avoid having the same information in more than one place. If
  313. you change the installation directories or top-level prefix at
  314. `configure'-time, those changes will propagate through the whole
  315. sequence.  And if you change the default paths in `texmf.in', those
  316. changes are propagated to the compile-time defaults.
  317.   The Make definitions are all repeated in several Makefile's; but
  318. changing the top-level `Makefile' should suffice, as it passes down all
  319. the variable definitions, thus overriding the submakes.  (The
  320. definitions are repeated so you can run Make in the subdirectories, if
  321. you should have occasion to.)
  322.   By default, the bitmap font paths end with `/$MAKETEX_MODE', thus
  323. including the device name (usually a Metafont mode name such as
  324. `ljfour').  This distinguishes two different devices with the same
  325. resolution--a write/white from a write/black 300dpi printer, for
  326. example.
  327.   However, since most sites don't have this complication, Kpathsea
  328. (specifically, the `kpse_init_prog' function in `kpathsea/proginit.c')
  329. has a special case: if the mode has not been explicitly set by the user
  330. (or in a configuration file), it sets `MAKETEX_MODE' to `/'.  This
  331. makes the default PK path, for example, expand into `.../pk//', so
  332. fonts will be found even if there is no subdirectory for the mode (if
  333. you arranged things that way because your site has only one printer,
  334. for example) or if the program is mode-independent (e.g., `pktype').
  335.   To make the paths independent of the mode, simply edit `texmf.in'
  336. before installation, or the installed `texmf.cnf', and remove the
  337. `$MAKETEX_MODE'.
  338.   *Note mktex script arguments::, for how this interacts with `mktexpk'.
  339.   *Note TeX directory structure: TeX directory structure, for a
  340. description of the default arrangement of the input files that comprise
  341. the TeX system.  The file `kpathsea/HIER' is a copy of that section.
  342. File: kpathsea.info,  Node: Default path generation,  Prev: Default path features,  Up: Changing search paths
  343. Default path generation
  344. .......................
  345.   This section describes how the default paths are constructed.
  346.   You may wish to ignore the whole mess and simply edit `texmf.cnf'
  347. after it is installed, perhaps even copying it into place beforehand so
  348. you can complete the installation, if it seems necessary.
  349.   To summarize the chain of events that go into defining the default
  350. paths:
  351.   1. `configure' creates a `Makefile' from each `Makefile.in'.
  352.   2. When Make runs in the `kpathsea' directory, it creates a file
  353.      `texmf.sed' that substitutes the Make value of `$(var)' for a
  354.      string `@var@'.  The variables in question are the one that define
  355.      the installation directories.
  356.   3. `texmf.sed' (together with a little extra magic--see
  357.      `kpathsea/Makefile') is applied to `texmf.in' to generate
  358.      `texmf.cnf'.  This is the file that will eventually be installed
  359.      and used.
  360.   4. The definitions in `texmf.cnf' are recast as C `#define''s in
  361.      `paths.h'.  These values will be the compile-time defaults; they
  362.      are not used at runtime unless no `texmf.cnf' file can be found.
  363.      (That's a lie: the compile-time defaults are what any extra :'s in
  364.      `texmf.cnf' expand into; but the paths as distributed have no extra
  365.      :'s, and there's no particular reason for them to.)
  366. File: kpathsea.info,  Node: Running configure,  Next: Running make,  Prev: Changing search paths,  Up: Custom installation
  367. Running `configure'
  368. -------------------
  369.   Run `sh configure OPTIONS' (in the top-level directory, the one
  370. containing `kpathsea/'), possibly using a shell other than `sh' (*note
  371. configure shells::.).
  372.   `configure' adapts the source distribution to the present system via
  373. `#define''s in `*/c-auto.h', which are created from the corresponding
  374. `c-auto.in'.  It also creates a `Makefile' from the corresponding
  375. `Makefile.in', doing `@VAR@' and `ac_include' substitutions).
  376.   `configure' is the best place to control the configuration,
  377. compilation, and installed location of the software, either via
  378. command-line options, or by setting environment variables before
  379. invoking it.  For example, you can disable `mktexpk' by default with
  380. the option `--disable-mktexpk'.  *Note configure options::.
  381. * Menu:
  382. * configure shells::
  383. * configure options::
  384. * configure environment::
  385. * configure scenarios::
  386. * Shared library::
  387. File: kpathsea.info,  Node: configure shells,  Next: configure options,  Up: Running configure
  388. `configure' shells
  389. ..................
  390.   Considerable effort has gone into trying to ensure that the
  391. `configure' scripts can be run by most Bourne shell variants.  Should
  392. `sh' run into trouble, your best bet is to use Bash, the GNU shell
  393. (*note Top: (features)Top.).
  394.   Bourne shell variants for which problems have been reported in the
  395. past are:
  396. `ksh'
  397.      Old versions of the Korn shell may fail to handle the scripts.
  398.      The Korn shell may be installed as `/bin/sh' on AIX, in which case
  399.      `/bin/bsh' may serve instead.
  400. `ash'
  401.      Old versions of ash are unable to handle the scripts.  Ash is
  402.      sometimes installed as `/bin/sh' on NetBSD, FreeBSD, and Linux
  403.      systems.  `/bin/bash' should be available for those systems, but
  404.      might not be part of a default installation.
  405. `Ultrix /bin/sh'
  406.      `/bin/sh' under Ultrix is a DEC-grown shell that is notably
  407.      deficient in many ways.  `/bin/sh5' may be necessary.
  408. File: kpathsea.info,  Node: configure options,  Next: configure environment,  Prev: configure shells,  Up: Running configure
  409. `configure' options
  410. ...................
  411.   For a complete list of all `configure' options, run `configure
  412. --help' or see *Note Running `configure' scripts: (autoconf)Invoking
  413. configure, (a copy is in the file `kpathsea/README.CONFIGURE').  The
  414. generic options are listed first in the `--help' output, and the
  415. package-specific options come last.  The environment variables
  416. `configure' pays attention to are listed below.
  417.   Options particularly likely to be useful are `--prefix', `--datadir',
  418. and the like; see *Note configure scenarios::.
  419.   This section gives pointers to descriptions of the `--with' and
  420. `--enable' options to `configure' that Kpathsea-using programs accept.
  421. `--without-mktexmf-default'
  422. `--without-mktexpk-default'
  423. `--without-mktextfm-default'
  424. `--with-mktextex-default'
  425.      Enable or disable the dynamic generation programs.  *Note mktex
  426.      configuration::.
  427. `--enable-shared'
  428.      Build Kpathsea as a shared library, and link against it.  Also
  429.      build the usual static library.  *Note Shared library::.
  430. `--disable-static'
  431.      Build only the shared library.   Implies `--enable-shared'.
  432. `--enable-maintainer-mode'
  433.      Enables make targets that are useful for the maintainer and likely
  434.      to be a pain for anyone else; the makefiles created when this
  435.      option is enabled may not work at all for you.  You have been
  436.      warned.
  437. File: kpathsea.info,  Node: configure environment,  Next: configure scenarios,  Prev: configure options,  Up: Running configure
  438. `configure' environment
  439. .......................
  440.   `configure' uses the value of the following environment variables in
  441. determining your system's characteristics, and substitutes for them in
  442. Makefile's:
  443.      The compiler to use: default is `gcc' if it's installed, otherwise
  444.      `cc'.
  445. `CFLAGS'
  446.      Options to give the compiler: default is `-g -O2' for `gcc', `-g'
  447.      otherwise.  `CFLAGS' comes after any other options.  You may need
  448.      to include `-w' here if your compilations commonly have useless
  449.      warnings (e.g., `NULL redefined'), or `configure' may fail to
  450.      detect the presence of header files (it takes the messages on
  451.      standard error to mean the header file doesn't exist).
  452. `CPPFLAGS'
  453.      Options to pass to the compiler preprocessor; this matters most for
  454.      configuration, not the actual source compilation.  The `configure'
  455.      script often does only preprocessing (e.g., to check for the
  456.      existence of #include files), and `CFLAGS' is not used for this.
  457.      You may need to set this to something like
  458.      `-I/usr/local/include/wwwhatever' if you have the libwww library
  459.      installed for hyper-xdvik (see `xdvik/INSTALL').
  460. `DEFS'
  461.      Additional preprocessor options, but not used by `configure'.
  462.      Provided for enabling or disabling program features, as documented
  463.      in the various program-specific installation instructions.  `DEFS'
  464.      comes before any compiler options included by the distribution
  465.      `Makefile's or by `configure'.
  466. `LDFLAGS'
  467.      Additional options to give to the loader.  `LDFLAGS' comes before
  468.      any other linker options.
  469. `LIBS'
  470.      Additional libraries to link with.
  471. File: kpathsea.info,  Node: configure scenarios,  Next: Shared library,  Prev: configure environment,  Up: Running configure
  472. `configure' scenarios
  473. .....................
  474.   Here are some common installation scenarios:
  475.    * Including X support in Metafont.  This is disabled by default,
  476.      since many sites have no use for it, and it's a leading cause of
  477.      configuration problems.
  478.           configure --with-x
  479.    * Putting the binaries, TeX files, GNU info files, etc. into a single
  480.      TeX hierarchy, say `/here/texmf', requires overriding defaults in
  481.      `configure':
  482.           configure --prefix=/here/texmf --datadir=/here
  483.    * You can compile on multiple architectures simultaneously either by
  484.      building symbolic link trees with the `lndir' script from the X11
  485.      distribution, or with the `--srcdir' option:
  486.           configure --srcdir=SRCDIR
  487.    * If you are installing binaries for multiple architectures into a
  488.      single hierarchy, you will probably want to override the default
  489.      `bin' and `lib' directories, something like this:
  490.           configure --prefix=TEXMF --datadir=TEXMF \
  491.             --bindir=TEXMF/ARCH/bin --libdir=TEXMF/ARCH/lib
  492.           make texmf=TEXMF
  493.       (Unless you make provisions for architecture-specific files in
  494.      other ways, e.g., with Depot or an automounter.)
  495.    * To compile with optimization (to compile without debugging, remove
  496.      the `-g'):
  497.           env CFLAGS="-g -O" sh configure ...
  498.       For a potential problem if you optimize, see *Note TeX or
  499.      Metafont failing: TeX or Metafont failing.
  500. File: kpathsea.info,  Node: Shared library,  Prev: configure scenarios,  Up: Running configure
  501. Shared library
  502. ..............
  503.   You can compile Kpathsea as a shared library on a few systems, by
  504. specifying the option `--enable-shared' when you run `configure'.
  505.   The main advantage in doing this is that the executables can then
  506. share the code, thus decreasing memory and disk space requirements.
  507.   On some systems, you can record the location of shared libraries in a
  508. binary, usually by giving certain options to the linker.  Then
  509. individual users do not need to set their system's environment variable
  510. (e.g., `LD_LIBRARY_PATH') to find shared libraries.  If you want to do
  511. this, you will need to add the necessary options to `LDFLAGS' yourself;
  512. for example, on Solaris, include something like `-R${prefix}/lib', on
  513. IRIX or Linux, use `-rpath${prefix}/lib'.  (Unfortunately, making this
  514. happen by default is very difficult, because of interactions with an
  515. existing installed shared library.)
  516.   Currently, shared library support is implemented only on Linux, SunOS
  517. 4 (Solaris 1), SunOS 5 (Solaris 2), IRIX 5, and IRIX 6.  If you're
  518. interested and willing in adding support for other systems, please see
  519. the `configure' mode in the `klibtool' script, especially the
  520. host-specific case statement around line 250.
  521. File: kpathsea.info,  Node: Running make,  Next: Installing files,  Prev: Running configure,  Up: Custom installation
  522. Running `make'
  523. --------------
  524.   `make' (still in the top-level directory).  This also creates the
  525. `texmf.cnf' and `paths.h' files that define the default search paths,
  526. and (by default) the `plain' and `latex' TeX formats.
  527.   You can override directory names and other values at `make'-time.
  528. `make/paths.make' lists the variables most commonly reset.  For
  529. example, `make default_texsizes=600' changes the list of fallback
  530. resolutions.
  531.   You can also override each of `configure''s environment variables
  532. (*note configure environment::.).  The Make variables have the same
  533. names.
  534.   Finally, you can supply additional options via the following
  535. variables.  (`configure' does not use these.)
  536. `XCPPFLAGS'
  537. `XDEFS'
  538.      Preprocessor options.
  539. `XCFLAGS'
  540.      Compiler options.
  541. `XLDFLAGS'
  542.      Loader options (included at beginning of link commands).
  543. `XLOADLIBES'
  544.      More loader options (included at end of link commands).
  545. `XMAKEARGS'
  546.      Additional Make arguments passed to all sub-`make''s. You may need
  547.      to include assignments to the other variables here via `XMAKEARGS';
  548.      for example: `make XMAKEARGS="CFLAGS=-O XDEFS=-DA4"'.
  549.   It's generally a bad idea to use a different compiler (`CC') or
  550. libraries (`LIBS') for compilation than you did for configuration,
  551. since the values `configure' determined may then be incorrect.
  552.   Adding compiler options to change the "universe" you are using
  553. (typically BSD vs. system V) is generally a cause of trouble.  It's
  554. best to use the native environment, whatever that is; `configure' and
  555. the software usually adapt best to that.  In particular, under Solaris
  556. 2.x, you should not use the BSD-compatibility library (`libucb') or
  557. include files (`ucbinclude').
  558.   If you want to use the Babel LaTeX package for support of non-English
  559. typesetting, you need to modify some files before making the LaTeX
  560. format.  See the file `install.txt' in the Babel distribution.
  561. File: kpathsea.info,  Node: Installing files,  Next: Cleaning up,  Prev: Running make,  Up: Custom installation
  562. Installing files
  563. ----------------
  564.   The basic command is the usual `make install'.  For security issues,
  565. *note Security::..
  566.   The first time you install any manual in the GNU Info system, you
  567. should add a line (you choose where) to the file `dir' in your
  568. `$(infodir)' directory.  Sample text for this is given near the top of
  569. the Texinfo source files (`kpathsea/kpathsea.texi',
  570. `dvipsk/dvips.texi', and `web2c/doc/web2c.texi').  If you have a recent
  571. version of the GNU Texinfo distribution installed
  572. (`ftp://prep.ai.mit.edu/pub/gnu/texinfo-3.9.tar.gz' or later), this
  573. should happen automatically.
  574.   On the offchance that this is your first Info installation, the `dir'
  575. file I use is included in the distribution as `etc/dir-example'.
  576.   You may wish to use one of the following targets, especially if you
  577. are installing on multiple architectures:
  578.    * `make install-exec' to install in architecture-dependent
  579.      directories, i.e., ones that depend on the `$(exec_prefix)' Make
  580.      variable.  This includes links to binaries, libraries, etc., not
  581.      just "executables".
  582.    * `make install-data' to install in architecture-independent
  583.      directories, such as documentation, configuration files, pool
  584.      files, etc.
  585.   If you use the Andrew File System, the normal path (e.g., PREFIX/bin)
  586. only gets you to a read-only copy of the files, and you must specify a
  587. different path for installation.  The best way to do this is by setting
  588. the `prefix' variable on the `make' command line.  The sequence becomes
  589. something like this:
  590.      configure --prefix=/whatever
  591.      make
  592.      make install prefix=/afs/.SYSTEM.NAME/system/1.3/@sys/whatever
  593.    With AFS, you will definitely want to use relative filenames in
  594. `ls-R' (*note Filename database::.), not absolute filenames.  This is
  595. done by default, but check anyway.
  596. File: kpathsea.info,  Node: Cleaning up,  Next: Filename database generation,  Prev: Installing files,  Up: Custom installation
  597. Cleaning up
  598. -----------
  599. The basic command is `make distclean'.  This removes all files created
  600. by the build.
  601.   Alternatively,
  602.    * `make mostlyclean' if you intend to compile on another
  603.      architecture.  For Web2C, since the generated C files are portable,
  604.      they are not removed.  If the `lex' vs. `flex' situation is going
  605.      to be different on the next machine, `rm web2c/lex.yy.c'.
  606.    * `make clean' to remove files created by compiling, but leave
  607.      configuration files and Makefiles.
  608.    * `make maintainer-clean' to remove everything that the Makefiles can
  609.      rebuild.  This is more than `distclean' removes, and you should
  610.      only use it if you are thoroughly conversant with (and have the
  611.      necessary versions of) Autoconf.
  612.    * `make extraclean' to remove other junk, e.g., core files, log
  613.      files, patch rejects.  This is independent of the other `clean'
  614.      targets.
  615. File: kpathsea.info,  Node: Filename database generation,  Next: mktex scripts,  Prev: Cleaning up,  Up: Custom installation
  616. Filename database generation
  617. ----------------------------
  618.   You will probably want to set up a `cron' entry on the appropriate
  619. machine(s) to rebuild the filename database nightly or so, as in:
  620.      0 0 * * * cd TEXMF && /BINDIR/mktexlsr
  621.    *Note Filename database::.
  622. Although the `mktex...' scripts make every effort to add newly-created
  623. files on the fly, it can't hurt to make sure you get a fresh version
  624. every so often.
  625. File: kpathsea.info,  Node: mktex scripts,  Next: Installation testing,  Prev: Filename database generation,  Up: Custom installation
  626. `mktex' scripts
  627. ---------------
  628.   If Kpathsea cannot otherwise find a file, for some file types it is
  629. configured by default to invoke an external program to create it
  630. dynamically (*note mktex configuration::.).  This is most useful for
  631. fonts (bitmaps, TFM's, and arbitrarily-sizable Metafont sources such as
  632. the Sauter and EC fonts), since any given document can use fonts never
  633. before referenced.  Trying to build all fonts in advance is therefore
  634. impractical, if not impossible.
  635.   The script is passed the name of the file to create and possibly other
  636. arguments, as explained below.  It must echo the full pathname of the
  637. file it created (and nothing else) to standard output; it can write
  638. diagnostics to standard error.
  639. * Menu:
  640. * mktex configuration::
  641. * mktex script names::
  642. * mktex script arguments::
  643. File: kpathsea.info,  Node: mktex configuration,  Next: mktex script names,  Up: mktex scripts
  644. `mktex' configuration
  645. .....................
  646.   The following file types can run an external program to create missing
  647. files: `pk', `tfm', `mf', `tex'; the scripts are named `mktexpk',
  648. `mktextfm', `mktexmf', and `mktextex'.
  649.   In the absence of `configure' options specifying otherwise,
  650. everything but `mktextex' will be enabled by default. The `configure'
  651. options to change the defaults are:
  652.      --without-mktexmf-default
  653.      --without-mktexpk-default
  654.      --without-mktextfm-default
  655.      --with-mktextex-default
  656.   The `configure' setting is overridden if the environment variable or
  657. configuration file value named for the script is set; e.g., `MKTEXPK'
  658. (*note mktex script arguments::.).
  659.   As distributed, all the scripts source a file `texmf/web2c/mktex.cnf'
  660. if it exists, so you can override various defaults.  See `mktex.opt',
  661. for instance, which defines the default mode, resolution, some special
  662. directory names, etc.  If you prefer not to change the distributed
  663. scripts, you can simply create `mktex.cnf' with the appropriate
  664. definitions (you do not need to create it if you have nothing to put in
  665. it).  `mktex.cnf' has no special syntax; it's an arbitrary Bourne shell
  666. script.  The distribution contains a sample `mktex.cnf' for you to copy
  667. and modify as you please (it is not installed anywhere).
  668.   In addition, you can configure a number of features with the
  669. `MT_FEATURES' variable, which you can define:
  670.    * in `mktex.opt', as just mentioned;
  671.    * by editing the file `mktex.opt', either before `make install' (in
  672.      the source hierarchy) or after (in the installed hierarchy);
  673.    * or in the environment.
  674.   If none of the options below are enabled, `mktexpk', `mktextfm', and
  675. `mktexmf' follow the following procedure to decide where fonts should
  676. be installed.  Find the tree where the font's sources are, and test the
  677. permissions of the `fonts' directory of that tree to determine whether
  678. it is writable.  If it is, put the files in the tree in appropriate
  679. locations.  If it isn't writable, see whether the tree is a system tree
  680. (named in `SYSTEXMF').  If so, the `VARTEXFONTS' tree is used.  In all
  681. other cases the working directory is used.
  682.   The `appendonlydir' option is enabled by default.
  683. `appendonlydir'
  684.      Tell `mktexdir' to create directories append-only, i.e., set their
  685.      sticky bit (*note Mode Structure: (fileutils)Mode Structure.).
  686.      This feature is silently ignored on non-Unix platforms (e.g.
  687.      Windows/NT and MS-DOS) which don't support similar functionality.
  688.      This feature is enabled by default.
  689. `dosnames'
  690.      Use 8.3 names; e.g., `dpi600/cmr10.pk' instead of `cmr10.600pk'.
  691.      Note that this feature only affects filenames that would otherwise
  692.      clash with other TeX-related filenames; `mktex' scripts do nothing
  693.      about filenames which exceed the 8+3 MS-DOS limits but remain
  694.      unique when truncated (by the OS) to these limits, and nether do
  695.      the scripts care about possible clashes with files which aren't
  696.      related with TeX.  For example, `cmr10.600pk' would clash with
  697.      `cmr10.600gf' and is therefore changed when `dosnames' is in
  698.      effect, but `mf.pool' and `mp.base' don't clash with any
  699.      TeX-related files and are therefore unchanged.
  700.      This feature is turned on by default on MS-DOS.  If you do not wish
  701.      `dosnames' to be set on an MS-DOS platform, you need to set the
  702.      `MT_FEATURES' environment variable to a value that doesn't include
  703.      `dosnames'.  You can also change the default setting by editing
  704.      `mktex.opt', but only if you use the `mktex' shell scripts; the
  705.      emulation programs don't consult `mktex.opt'.
  706. `fontmaps'
  707.      Instead of deriving the location of a font in the destination tree
  708.      from the location of the sources, the aliases and directory names
  709.      from the Fontname distribution are used. (*note Introduction:
  710.      (fontname)Top.).
  711. `nomfdrivers'
  712.      Let mktexpk and mktextfm create metafont driver files in a
  713.      temporary directory.  These will be used for just one metafont run
  714.      and not installed permanently.
  715. `nomode'
  716.      Omit the directory level for the mode name; this is fine as long as
  717.      you generate fonts for only one mode.
  718. `stripsupplier'
  719.      Omit the font supplier name directory level.
  720. `striptypeface'
  721.      Omit the font typeface name directory level.
  722. `strip'
  723.      Omit the font supplier and typeface name directory levels.  This
  724.      feature is deprecated in favour of `stripsupplier' and
  725.      `striptypeface'.
  726. `varfonts'
  727.      When this option is enabled, fonts that would otherwise be written
  728.      in system texmf tree go to the `VARTEXFONTS' tree instead.  The
  729.      default value in `kpathsea/Makefile.in' is `/var/tmp/texfonts'.
  730.      The `Linux File System Standard' recommends `/var/tex/fonts'.
  731.      The `varfonts' setting in `MT_FEATURES' is overridden by the
  732.      `USE_VARTEXFONTS' environment variable: if set to `1', the feature
  733.      is enabled, and if set to `0', the feature is disabled.
  734. File: kpathsea.info,  Node: mktex script names,  Next: mktex script arguments,  Prev: mktex configuration,  Up: mktex scripts
  735. `mktex' script names
  736. ....................
  737.   The following table shows the default name of the script for each
  738. possible file types.  (The source is the variable `kpse_make_specs' in
  739. `kpathsea/tex-make.c'.)
  740. `mktexpk'
  741.      Glyph fonts.
  742. `mktextex'
  743.      TeX input files.
  744. `mktexmf'
  745.      Metafont input files.
  746. `mktextfm'
  747.      TFM files.
  748. These names are overridden by an environment variable specific to the
  749. program--for example, `DVIPSMAKEPK' for Dvipsk.
  750.   If a `mktex...' script fails, the invocation is appended to a file
  751. `missfont.log' (by default) in the current directory.  You can then
  752. execute the log file to create the missing files after fixing the
  753. problem.
  754.   If the current directory is not writable and the environment variable
  755. or configuration file value `TEXMFOUTPUT' is set, its value is used.
  756. Otherwise, nothing is written.  The name `missfont.log' is overridden
  757. by the `MISSFONT_LOG' environment variable or configuration file value.
  758. File: kpathsea.info,  Node: mktex script arguments,  Prev: mktex script names,  Up: mktex scripts
  759. `mktex' script arguments
  760. ........................
  761.   The first argument to a `mktex' script is always the name of the file
  762. to be created.
  763.   In the default `mktexpk' implementation, additional arguments may
  764. also be passed:
  765. `--dpi NUM'
  766.      Sets the resolution of the generated font to NUM.
  767. `--mfmode NAME'
  768.      Sets the Metafont mode to NAME.
  769. `--bdpi NUM'
  770.      Sets the the "base dpi" for the font.  This must match the mode
  771.      being used.
  772. `--mag STRING'
  773.      A "magstep" string suitable for the Metafont `mag' variable.  This
  774.      must match the combination of BDPI and DPI being used.
  775. `--destdir STRING'
  776.      A directory name. If the directory is absolute, it is used as-is.
  777.      Otherwise, it is appended to the root destination directory set in
  778.      the script.
  779. File: kpathsea.info,  Node: Installation testing,  Prev: mktex scripts,  Up: Custom installation
  780. Installation testing
  781. --------------------
  782.   Besides the tests listed in *Note Simple installation::, you can try
  783. running `make check'.  This includes the torture tests (trip, trap, and
  784. mptrap) that come with Web2c (*note Triptrap: (web2c)Triptrap.).
  785. File: kpathsea.info,  Node: Security,  Next: TeX directory structure,  Prev: Custom installation,  Up: Installation
  786. Security
  787. ========
  788.   None of the programs in the TeX system require any special system
  789. privileges, so there's no first-level security concern of people gaining
  790. illegitimate root access.
  791.   A TeX document, however, can write to arbitrary files, e.g.,
  792. `~/.rhosts', and thus an unwitting user who runs TeX on a random
  793. document is vulnerable to a trojan horse attack.  This loophole is
  794. closed by default, but you can be permissive if you so desire in
  795. `texmf.cnf'.  *Note tex invocation: (web2c)tex invocation.  MetaPost has
  796. the same issue.
  797.   Dvips, Xdvi, and TeX can also execute shell commands under some
  798. circumstances.  To disable this, see the `-R' option in *Note Option
  799. details: (dvips)Option details, the xdvi man page, and *Note tex
  800. invocation: (web2c)tex invocation, respectively.
  801.   Another security issue arises because it's very useful--almost
  802. necessary--to make arbitrary fonts on user demand with `mktexpk' and
  803. friends.  Where do these files get installed?  By default, the
  804. `mktexpk' distributed with Kpathsea assumes a world-writable `/var/tmp'
  805. directory; this is a simple and convenient approach, but it may not
  806. suit your situation because it means that a local cache of fonts is
  807. created on every machine.
  808.   To avoid this duplication, many people consider a shared, globally
  809. writable font tree desirable, in spite of the potential security
  810. problems.  To do this you should change the value of `VARTEXFONTS' in
  811. `texmf.cnf' to refer to some globally known directory.  *Note mktex
  812. configuration::.
  813.   The first restriction you can apply is to make newly-created
  814. directories under `texmf' be append-only with an option in `mktex.cnf'.
  815. *Note mktex configuration::.
  816.   Another approach is to establish a group (or user) for TeX files,
  817. make the `texmf' tree writable only to that group (or user), and make
  818. `mktexpk' et al. setgid to that group (or setuid to that user).  Then
  819. users must invoke the scripts to install things.  (If you're worried
  820. about the inevitable security holes in scripts, then you could write a
  821. C wrapper to exec the script.)
  822.   The `mktex...' scripts install files with the same read and write
  823. permissions as the directory they are installed in.  The executable,
  824. sgid, suid, and sticky bits are always cleared.
  825.   Any directories created by the `mktex...' scripts have the same
  826. permissions as their parent directory, unless the `appendonlydir'
  827. feature is used, in which case the sticky bit is always set.
  828. File: kpathsea.info,  Node: TeX directory structure,  Next: unixtex.ftp,  Prev: Security,  Up: Installation
  829. TeX directory structure
  830. =======================
  831.   This section describes the default installation hierarchy of the
  832. distribution.  It conforms to both the GNU coding standards and the TeX
  833. directory structure (TDS) standard.  For rationale and further
  834. explanation, please see those documents.  The GNU standard is available
  835. as `ftp://prep.ai.mit.edu/pub/gnu/standards/standards.texi' and
  836. mirrors.  The TDS document is available from `CTAN:/tex-archive/tds'
  837. (*note unixtex.ftp::.).
  838.   You can change the default paths in many ways (*note Changing search
  839. paths::.).  One common desire is to put everything (binaries and all)
  840. under a single top-level directory such as `/usr/local/texmf' or
  841. `/opt/texmf'--in the terms used below, make PREFIX and TEXMF the same.
  842. For specific instructions on doing that, see *Note configure
  843. scenarios::.
  844.   Here is a skeleton of the default directory structure, extracted from
  845. the TDS document:
  846.      PREFIX/      installation root (`/usr/local' by default)
  847.       bin/         executables
  848.       man/         man pages
  849.       include/     C header files
  850.       info/        GNU info files
  851.       lib/         libraries (`libkpathsea.*')
  852.       share/       architecture-independent files
  853.        texmf/      TDS root
  854.         bibtex/     BibTeX input files
  855.          bib/        BibTeX databases
  856.           base/       base distribution (e.g., `xampl.bib')
  857.           misc/       single-file databases
  858.           PKG/       name of a package
  859.          bst/        BibTeX style files
  860.           base/       base distribution (e.g., `plain.bst', `acm.bst')
  861.           misc/       single-file styles
  862.           PKG/       name of a package
  863.         doc/         additional documentation
  864.         dvips/       `.pro', `.ps', `psfonts.map'
  865.         fonts/       font-related files
  866.          TYPE/         file type (e.g., `tfm', `pk')
  867.           MODE/          type of output device (types `pk' and `gf' only)
  868.            SUPPLIER/       name of a font supplier (e.g., `public')
  869.             TYPEFACE/        name of a typeface (e.g., `cm')
  870.              dpiNNN/           font resolution (types `pk' and `gf' only)
  871.         metafont/    Metafont (non-font) input files
  872.          base/        base distribution (e.g., `plain.mf')
  873.          misc/        single-file packages (e.g., `modes.mf')
  874.          PKG/           name of a package (e.g., `mfpic')
  875.         metapost/    MetaPost input files
  876.          base/        base distribution (e.g., `plain.mp')
  877.          misc/        single-file packages
  878.          PKG/           name of a package
  879.          support/     support files for MetaPost-related utilities (e.g., `trfonts.map')
  880.         mft/         `MFT' inputs (e.g., `plain.mft')
  881.         tex/         TeX input files
  882.          FORMAT/         name of a format (e.g., `plain')
  883.           base/        base distribution for FORMAT (e.g., `plain.tex')
  884.           misc/        single-file packages (e.g., `webmac.tex')
  885.           local/       local additions to or local configuration files for FORMAT
  886.           PKG/           name of a package (e.g., `graphics', `mfnfss')
  887.          generic/     format-independent packages
  888.           hyphen/      hyphenation patterns (e.g., `hyphen.tex')
  889.           images/      image input files (e.g., Encapsulated PostScript)
  890.           misc/        single-file format-independent packages (e.g., `null.tex').
  891.           PKG/           name of a package (e.g., `babel')
  892.         web2c/        implementation-dependent files (`.pool', `.fmt', `texmf.cnf', etc.)
  893.   Some concrete examples for most file types:
  894.      /usr/local/bin/tex
  895.      /usr/local/man/man1/xdvi.1
  896.      /usr/local/info/kpathsea.info
  897.      /usr/local/lib/libkpathsea.a
  898.      /usr/local/share/texmf/bibtex/bst/base/plain.bst
  899.      /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
  900.      /usr/local/share/texmf/fonts/source/public/pandora/pnr10.mf
  901.      /usr/local/share/texmf/fonts/tfm/public/cm/cmr10.tfm
  902.      /usr/local/share/texmf/fonts/type1/adobe/utopia/putr.pfa
  903.      /usr/local/share/texmf/metafont/base/plain.mf
  904.      /usr/local/share/texmf/metapost/base/plain.mp
  905.      /usr/local/share/texmf/tex/plain/base/plain.tex
  906.      /usr/local/share/texmf/tex/generic/hyphen/hyphen.tex
  907.      /usr/local/share/texmf/web2c/tex.pool
  908.      /usr/local/share/texmf/web2c/tex.fmt
  909.      /usr/local/share/texmf/web2c/texmf.cnf
  910. File: kpathsea.info,  Node: unixtex.ftp,  Next: Reporting bugs,  Prev: TeX directory structure,  Up: Installation
  911. `unixtex.ftp': Obtaining TeX
  912. ============================
  913.   This is `ftp://ftp.tug.org/tex/unixtex.ftp', last updated 18 March
  914. 1998.  Also available as `http://www.tug.org/unixtex.ftp'.  The IP
  915. address is currently `[158.121.106.10]', and the canonical host name is
  916. currently `tug.org'.  It is also in Kpathsea source distributions as
  917. `etc/unixtex.ftp' (although the network version is usually newer).
  918. Mail <kb@mail.tug.org> with comments or questions.
  919.   Following are general instructions for Unix or other sites who wish to
  920. acquire the Web2c distribution, (plain) TeX, LaTeX (2e), BibTeX,
  921. Metafont, MetaPost, DVI processors for the X window system, PostScript,
  922. the PCL language in the HP LaserJet, and related programs.  They are
  923. oriented towards building from the original sources, though some
  924. information on alternative packages is included in the last section.
  925. See also `http://www.tug.org/web2c', the Web2c and Kpathsea home page.
  926.   Please consider joining the TeX Users Group (TUG) to help support the
  927. maintenance and development of the programs you retrieve.  Email
  928. <office@tug.org> or see `http://www.tug.org' for information and a
  929. membership form.
  930.   For actual installation instructions after obtaining the necessary
  931. sources, see *Note Installation::.  A copy is in the distribution file
  932. `kpathsea/INSTALL'.
  933. * Menu:
  934. * Electronic distribution::  CTAN and so forth.
  935. * CD-ROM distribution::
  936. * Other TeX packages::
  937. File: kpathsea.info,  Node: Electronic distribution,  Next: CD-ROM distribution,  Up: unixtex.ftp
  938. Electronic distribution
  939. -----------------------
  940.   In many places we refer to CTAN:.  This is *both* a host name and a
  941. directory name.  Here are some primary locations:
  942.      `ftp://ctan.tug.org/tex-archive'    (California, USA)
  943.      `ftp://ftp.dante.de/tex-archive'    (Germany)
  944.      `ftp://ftp.tex.ac.uk/tex-archive'   (England)
  945. CTAN has many mirrors worldwide; see the top-level file
  946. `README.mirrors' from one of the sites above, or finger
  947. <ctan@ftp.tug.org>, or see `http://www.tug.org/CTAN.sites'.  A list
  948. current as of the time of distribution is in the top-level file
  949. `./MIRROR'.
  950.   You can also access CTAN via the World Wide Web, Gopher, electronic
  951. mail, or NFS.  The same `README.mirrors' file explains how.
  952.   You will need to retrieve some or all of the following archives,
  953. depending on your needs (don't forget to set binary mode for file
  954. transfers):
  955. `CTAN:/systems/web2c/texmflib.tar.gz'
  956.      A basic collection of fonts (TFM files only) and macro packages
  957.      (including Texinfo and LaTeX 2e).  It unpacks into `texmf/'; if
  958.      you change the structure of this hierarchy, you will also have to
  959.      change the default search paths (*note Changing search paths::.).
  960.      It is required unless you already have these files, in which case
  961.      you should change the default paths as necessary to find them.
  962. `CTAN:/systems/web2c/web.tar.gz'
  963.      The original WEB source files, written mostly by Don Knuth.
  964.      Required unless you already have this `web' version.  (The WEB
  965.      sources change irregularly with respect to Web2c itself.)  Unpacks
  966.      into `web2c-VERSION'.
  967. `CTAN:/systems/web2c/web2c.tar.gz'
  968.      The Web2c system.  Required.  Also unpacks into `web2c-VERSION'.
  969. `CTAN:/systems/web2c/web2c-etex.tar.gz'
  970.      Additions to the Web2c system for building e-TeX.  Optional.
  971.      Unpacks into `web2c-VERSION'.
  972. `CTAN:/systems/web2c/etexlib.tar.gz'
  973.      Additions to the texmf tree needed to build e-TeX.  Optional.
  974.      Unpacks into `texmf/'.
  975. `CTAN:/systems/web2c/etexdoc.tar.gz'
  976.      Documentation for e-TeX as an addition to the texmf tree.
  977.      Optional.  Unpacks into `texmf/'.
  978. `CTAN:/systems/web2c/web2c-omega.tar.gz'
  979.      Additions to the Web2c system for building Omega.  Optional.
  980.      Unpacks into `web2c-VERSION'.
  981. `CTAN:/systems/web2c/omegalib.tar.gz'
  982.      Additions to the texmf tree needed to build Omega.  Optional.
  983.      Unpacks into `texmf/'.
  984. `CTAN:/systems/web2c/omegadoc.tar.gz'
  985.      Documentation for Omega as an addition to the texmf tree.
  986.      Optional.  Unpacks into `texmf/'.
  987. `CTAN:/systems/web2c/web2c-pdftex.tar.gz'
  988.      Additions to the Web2c system for building pdfTeX.  Optional.
  989.      Unpacks into `web2c-VERSION'.
  990. `CTAN:/systems/web2c/pdftexlib.tar.gz'
  991.      Additions to the texmf tree needed to build pdfTeX.  Optional.
  992.      Unpacks into `texmf/'.
  993. `CTAN:/systems/web2c/pdftexdoc.tar.gz'
  994.      Unpacks into `texmf/'.  Documentation for pdfTeX as an addition to
  995.      the texmf tree.  Optional.  Unpacks into `texmf/'.
  996. `CTAN:/systems/web2c/texk.tar.gz'
  997.      The web and web2c sources, plus the additions for web2c, plus the
  998.      dvi drivers mentioned below, plus extra dvi drivers and tools not
  999.      packaged separately.  Recommended if you want to build a complete
  1000.      system.  Unpacks into `texk-VERSION'.
  1001. `CTAN:/systems/web2c/texklib.tar.gz'
  1002.      The basic texmf tree, plus the additions for e-TeX, Omega, and
  1003.      pdfTeX.  The match for texk.tar.gz.  Unpacks into `texmf/'.
  1004. `CTAN:/dviware/dvipsk/dvipsk.tar.gz'
  1005.      DVI-to-PostScript translator.  Unpacks into `dvipsk-VERSION'.
  1006.      Optional.
  1007. `CTAN:/dviware/xdvik/xdvik.tar.gz'
  1008.      X window system DVI previewer.  Unpacks into `xdvik-VERSION'.
  1009.      Optional.
  1010. `CTAN:/dviware/dviljk/dviljk.tar.gz'
  1011.      DVI-to-PCL (HP LaserJet) translator.  Unpacks into
  1012.      `dviljk-VERSION'.  Optional.
  1013.   All that said, the originating host for the software above is
  1014. `ftp.tug.org'.  You can retrieve these distributions (but not much
  1015. else) from the `tex/' directory on that host.
  1016. File: kpathsea.info,  Node: CD-ROM distribution,  Next: Other TeX packages,  Prev: Electronic distribution,  Up: unixtex.ftp
  1017. CD-ROM distribution
  1018. -------------------
  1019.   Numerous organizations distribute various TeX CD-ROM's:
  1020.    * TUG, UK TUG, and GUTenberg (French-speaking TeX user group)
  1021.      collaborated to produce the `TeX Live' CD-ROM, based on teTeX,
  1022.      which in turn is based on Web2c; email <tex-live@mail.tug.org> or
  1023.      see `http://www.tug.org/tex-live.html'.
  1024.    * Dante (the German-speaking TeX user group) has produced a CD-ROM.
  1025.      See `http://www.dante.de/dante/DANTE-CTAN-CD-ROM.html', and
  1026.      `http://www.dante.de/tex-informationen/CD-ROMs.html' for
  1027.      information about TeX CD's in general.  Both are in German.
  1028.    * The Free Software Foundation's `Source Code CD-ROM' contains the
  1029.      minimal TeX source distribution described in the previous section
  1030.      (i.e., enough to print GNU documentation); email
  1031.      <gnu@prep.ai.mit.edu>.
  1032.    * The Gateway! CD-ROM set contains a runnable NetBSD/Amiga
  1033.      distribution and sources; see
  1034.      `http://www.netbsd.org/Sites/cdroms.html'.
  1035.    * The InfoMagic CD-ROM is a copy of CTAN (see previous section); see
  1036.      `http://www.infomagic.com'.
  1037.    * NTG (Dutch-speaking TeX user group) produced the 4allTeX CD-ROM;
  1038.      email <ntg@nic.surfnet.nl>, or see `http://www.ntg.nl/4allcd/'.
  1039.      This is a runnable system.
  1040.    * The Prime Time TeXcetera CD-ROM is also a copy of CTAN; email
  1041.      <ptf@ctcl.com> or see `http://www.ptf.com/ptf/'.
  1042.    * Walnut Creek's TeX CD-ROM is also a copy of CTAN; email
  1043.      <info@cdrom.com> or see `http://www.cdrom.com:/titles/tex.html'.
  1044.    * Most Linux distributions include some TeX package based on Web2c;
  1045.      see the Linux documentation file `Distribution-HOWTO' for a
  1046.      comparison of Linux distributions, available (for example) via
  1047.      `http://www.linux.org'.
  1048.   If you know of additional TeX CD-ROM distributions to add to this
  1049. list, please inform <kb@mail.tug.org>.
  1050. File: kpathsea.info,  Node: Other TeX packages,  Prev: CD-ROM distribution,  Up: unixtex.ftp
  1051. Other TeX packages
  1052. ------------------
  1053.   Many other TeX implementations are available in `CTAN:/systems',
  1054. including ready-to-run distributions for Unix, Amiga, Acorn, VMS,
  1055. Macintosh, DOS, and Windows (in various forms).  Although Web2c has
  1056. support in the source code for many operating systems, and in fact some
  1057. of the other distributions are based on it, it's unlikely to work as
  1058. distributed on anything but Unix.  (Please contribute improvements!)
  1059.   The Unix distribution alluded to above is the teTeX distribution.
  1060. This includes both complete sources and precompiled binaries for many
  1061. popular Unix variants, including Linux. It is based on Web2c, and
  1062. contains many other TeX-related programs as well.
  1063.   The host labrea.stanford.edu is the original source for the files for
  1064. which Donald Knuth is directly responsible: `tex.web', `plain.tex',
  1065. etc. However, unless you want to build your TeX library tree ab initio,
  1066. it is more reliable and less work to retrieve these files as part of
  1067. the above packages. In any case, labrea is not the canonical source for
  1068. anything except what was created by Stanford TeX project, so do not
  1069. rely on all the files available at that ftp site being up-to-date.
  1070. File: kpathsea.info,  Node: Reporting bugs,  Prev: unixtex.ftp,  Up: Installation
  1071. Reporting bugs
  1072. ==============
  1073.   (A copy of this chapter is in the file `kpathsea/BUGS'.)
  1074.   If you have problems or suggestions, please report them to
  1075. <tex-k@mail.tug.org> using the bug checklist below.
  1076.   Please report bugs in the documentation; not only factual errors or
  1077. inconsistent behavior, but unclear or incomplete explanations, typos,
  1078. wrong fonts, ...
  1079. * Menu:
  1080. * Bug checklist::       What to include in a good bug report.
  1081. * Mailing lists::       Joining the bugs or announcements mailing lists.
  1082. * Debugging::           Analyzing runtime problems.
  1083. * Logging::             Recording searches.
  1084. * Common problems::     When things go wrong.
  1085. File: kpathsea.info,  Node: Bug checklist,  Next: Mailing lists,  Up: Reporting bugs
  1086. Bug checklist
  1087. -------------
  1088.   Before reporting a bug, please check below to be sure it isn't already
  1089. known (*note Common problems::.).
  1090.   Bug reports should be sent via electronic mail to
  1091. <tex-k@mail.tug.org>, or by postal mail to 135 Center Hill Road /
  1092. Plymouth, MA 02360 / USA.
  1093.   The general principle is that a good bug report includes all the
  1094. information necessary for reproduction.  Therefore, to enable
  1095. investigation, your report should include the following:
  1096.    * The version number(s) of the program(s) involved, and of Kpathsea
  1097.      itself.  You can get the former by giving a sole option `--version'
  1098.      to the program, and the latter by running `kpsewhich --version'.
  1099.      The `NEWS' and `ChangeLog' files also contain the version number.
  1100.    * The hardware, operating system (including version number),
  1101.      compiler, and `make' program you are using (the output of `uname
  1102.      -a' is a start on the first two, though often incomplete).  If the
  1103.      bug involves the X window system, include X version and supplier
  1104.      information as well (examples: X11R6 from MIT; X11R4 from HP;
  1105.      OpenWindows 3.3 bundled with SunOS 4.1.4).
  1106.    * Any options you gave to `configure'.  This is recorded in the
  1107.      `config.status' files.
  1108.      If you are reporting a bug in `configure' itself, it's probably
  1109.      system-dependent, and it will be unlikely the maintainers can do
  1110.      anything useful if you merely report that thus-and-such is broken.
  1111.      Therefore, you need to do some additional work: for some bugs, you
  1112.      can look in the file `config.log' where the test that failed should
  1113.      appear, along with the compiler invocation and source program in
  1114.      question.  You can then compile it yourself by hand, and discover
  1115.      why the test failed.  Other `configure' bugs do not involve the
  1116.      compiler; in that case, the only recourse is to inspect the
  1117.      `configure' shell script itself, or the Autoconf macros that
  1118.      generated `configure'.
  1119.    * The log of all debugging output, if the bug is in path searching.
  1120.      You can get this by setting the environment variable
  1121.      `KPATHSEA_DEBUG' to `-1' before running the program.  Please look
  1122.      at the log yourself to make sure the behavior is really a bug
  1123.      before reporting it; perhaps "old" environment variable settings
  1124.      are causing files not to be found, for example.
  1125.    * The contents of any input files necessary to reproduce the bug.
  1126.      For bugs in DVI-reading programs, for example, this generally
  1127.      means a DVI file (and any EPS or other files it uses)--TeX source
  1128.      files are helpful, but the DVI file is necessary, because that's
  1129.      the actual program input.
  1130.      GNU `shar', available from `ftp://prep.ai.mit.edu/pub/gnu' is a
  1131.      convenient way of packaging multiple (possibly binary) files for
  1132.      electronic mail.  If you feel your input files are too big to send
  1133.      by email, you can ftp them to `ftp://ftp.tug.org/incoming' (that
  1134.      directory is writable, but not readable).
  1135.    * If you are sending a patch (do so if you can!), please do so in
  1136.      the form of a context diff (`diff -c') against the original
  1137.      distribution source.  Any other form of diff is either not as
  1138.      complete or harder for me to understand.  Please also include a
  1139.      `ChangeLog' entry.
  1140.    * If the bug involved is an actual crash (i.e., core dump), it is
  1141.      easy and useful to include a stack trace from a debugger (I
  1142.      recommend the GNU debugger GDB, available from
  1143.      `ftp://prep.ai.mit.edu/pub/gnu').  If the cause is apparent (a
  1144.      `NULL' value being dereferenced, for example), please send the
  1145.      details along.  If the program involved is TeX or Metafont, and
  1146.      the crash is happening at apparently-sound code, however, the bug
  1147.      may well be in the compiler, rather than in the program or the
  1148.      library (*note TeX or Metafont failing: TeX or Metafont failing.).
  1149.    * Any additional information that will be helpful in reproducing,
  1150.      diagnosing, or fixing the bug.
  1151. File: kpathsea.info,  Node: Mailing lists,  Next: Debugging,  Prev: Bug checklist,  Up: Reporting bugs
  1152. Mailing lists
  1153. -------------
  1154.   Web2c and Kpathsea in general are discussed on the mailing list
  1155. <tex-k@mail.tug.org>.  To join, email <tex-k-request@mail.tug.org> with
  1156. a line consisting of
  1157.      subscribe YOU@YOUR.PREFERRED.EMAIL.ADDRESS
  1158. in the body of the message.
  1159.   You do not need to join to submit a report, nor will it affect whether
  1160. you get a response.  There is no Usenet newsgroup equivalent (if you can
  1161. be the one to set this up, email `tex-k-request').  Traffic on the list
  1162. is fairly light, and is mainly bug reports and enhancement requests to
  1163. the software.  The best way to decide if you want to join or not is
  1164. read some of the archives from `ftp://ftp.tug.org/mail/archives/tex-k/'.
  1165.   Be aware that large data files are sometimes included in bug reports.
  1166. If this is a problem for you, do not join the list.
  1167.   If you only want announcements of new releases, not bug reports and
  1168. discussion, join <tex-archive@math.utah.edu> (via mail to
  1169. <tex-archive-request@math.utah.edu>).
  1170.   If you are looking for general TeX help, such as how to use LaTeX,
  1171. please use the mailing list <info-tex@shsu.edu> mailing list, which is
  1172. gatewayed to the `comp.text.tex' Usenet newsgroup (or post to the
  1173. newsgroup; the gateway is bidirectional).
  1174. File: kpathsea.info,  Node: Debugging,  Next: Logging,  Prev: Mailing lists,  Up: Reporting bugs
  1175. Debugging
  1176. ---------
  1177.   Kpathsea provides a number of runtime debugging options, detailed
  1178. below by their names and corresponding numeric values.  When the files
  1179. you expect aren't being found, the thing to do is enable these options
  1180. and examine the output.
  1181.   You can set these with some runtime argument (e.g., `-d') to the
  1182. program; in that case, you should use the numeric values described in
  1183. the program's documentation (which, for Dvipsk and Xdvik, are different
  1184. than those below).  It's best to give the `-d' (or whatever) option
  1185. first, for maximal output.  Dvipsk and Xdvik have additional
  1186. program-specific debugging options as well.
  1187.   You can also set the environment variable `KPATHSEA_DEBUG'; in this
  1188. case, you should use the numbers below.  If you run the program under a
  1189. debugger and set the variable `kpathsea_debug', also use the numbers
  1190. below.
  1191.   In any case, by far the simplest value to use is `-1', which will
  1192. turn on all debugging output.  This is usually better than guessing
  1193. which particular values will yield the output you need.
  1194.   Debugging output always goes to standard error, so you can redirect it
  1195. easily.  For example, in Bourne-compatible shells:
  1196.      dvips -d -1 ... 2>/tmp/debug
  1197.   It is sometimes helpful to run the standalone Kpsewhich utility
  1198. (*note Invoking kpsewhich::.), instead of the original program.
  1199.   In any case, you can *not* use the *names* below; you must always use
  1200. somebody's numbers.  (Sorry.)  To set more than one option, just sum
  1201. the corresponding numbers.
  1202. `KPSE_DEBUG_STAT (1)'
  1203.      Report `stat'(2) calls. This is useful for verifying that your
  1204.      directory structure is not forcing Kpathsea to do many additional
  1205.      file tests (*note Slow path searching::., and *note Subdirectory
  1206.      expansion::.). If you are using an up-to-date `ls-R' database
  1207.      (*note Filename database::.), this should produce no output unless
  1208.      a nonexistent file that must exist is searched for.
  1209. `KPSE_DEBUG_HASH (2)'
  1210.      Report lookups in all hash tables: `ls-R' and `aliases' (*note
  1211.      Filename database::.); font aliases (*note Fontmap::.); and config
  1212.      file values (*note Config files::.).  Useful when expected values
  1213.      are not being found, e.g.., file searches are looking at the disk
  1214.      instead of using `ls-R'.
  1215. `KPSE_DEBUG_FOPEN (4)'
  1216.      Report file openings and closings. Especially useful when your
  1217.      system's file table is full, for seeing which files have been
  1218.      opened but never closed. In case you want to set breakpoints in a
  1219.      debugger: this works by redefining `fopen' (`fclose') to be
  1220.      `kpse_fopen_trace' (`kpse_fclose_trace').
  1221. `KPSE_DEBUG_PATHS (8)'
  1222.      Report general path information for each file type Kpathsea is
  1223.      asked to search. This is useful when you are trying to track down
  1224.      how a particular path got defined--from `texmf.cnf', `config.ps',
  1225.      an environment variable, the compile-time default, etc.  This is
  1226.      the contents of the `kpse_format_info_type' structure defined in
  1227.      `tex-file.h'.
  1228. `KPSE_DEBUG_EXPAND (16)'
  1229.      Report the directory list corresponding to each path element
  1230.      Kpathsea searches. This is only relevant when Kpathsea searches
  1231.      the disk, since `ls-R' searches don't look through directory lists
  1232.      in this way.
  1233. `KPSE_DEBUG_SEARCH (32)'
  1234.      Report on each file search: the name of the file searched for, the
  1235.      path searched in, whether or not the file must exist (when drivers
  1236.      search for `cmr10.vf', it need not exist), and whether or not we
  1237.      are collecting all occurrences of the file in the path (as with,
  1238.      e.g., `texmf.cnf' and `texfonts.map'), or just the first (as with
  1239.      most lookups).  This can help you correlate what Kpathsea is doing
  1240.      with what is in your input file.
  1241. `KPSE_DEBUG_VARS (64)'
  1242.      Report the value of each variable Kpathsea looks up.  This is
  1243.      useful for verifying that variables do indeed obtain their correct
  1244.      values.
  1245. `GSFTOPK_DEBUG (128)'
  1246.      Activates debugging printout specific to `gsftopk' program.
  1247. `MAKETEX_DEBUG (512)'
  1248.      If you use the optional `mktex' programs instead of the
  1249.      traditional shell scripts, this will report the name of the site
  1250.      file (`mktex.cnf' by default) which is read, directories created by
  1251.      `mktexdir', the full path of the `ls-R' database built by
  1252.      `mktexlsr', font map searches, `MT_FEATURES' in effect, parameters
  1253.      from `mktexnam', filenames added by `mktexupd', and some
  1254.      subsidiary commands run by the programs.
  1255. `MAKETEX_FINE_DEBUG (1024)'
  1256.      When the optional `mktex' programs are used, this will print
  1257.      additional debugging info from functions internal to these
  1258.      programs.
  1259.   Debugging output from Kpathsea is always written to standard error,
  1260. and begins with the string `kdebug:'. (Except for hash table buckets,
  1261. which just start with the number, but you can only get that output
  1262. running under a debugger. See comments at the `hash_summary_only'
  1263. variable in `kpathsea/db.c'.)
  1264. File: kpathsea.info,  Node: Logging,  Next: Common problems,  Prev: Debugging,  Up: Reporting bugs
  1265. Logging
  1266. -------
  1267.   Kpathsea can record the time and filename found for each successful
  1268. search.  This may be useful in finding good candidates for deletion when
  1269. your filesystem is full, or in discovering usage patterns at your site.
  1270.   To do this, define the environment or config file variable
  1271. `TEXMFLOG'.  The value is the name of the file to append the
  1272. information to.  The file is created if it doesn't exist, and appended
  1273. to if it does.
  1274.   Each successful search turns into one line in the log file: two words
  1275. separated by a space. The first word is the time of the search, as the
  1276. integer number of seconds since "the epoch", i.e., UTC midnight 1
  1277. January 1970 (more precisely, the result of the `time' system call).
  1278. The second word is the filename.
  1279.   For example, after `setenv TEXMFLOG /tmp/log', running Dvips on
  1280. `story.dvi' appends the following lines:
  1281.      774455887 /usr/local/share/texmf/dvips/config.ps
  1282.      774455887 /usr/local/share/texmf/dvips/psfonts.map
  1283.      774455888 /usr/local/share/texmf/dvips/texc.pro
  1284.      774455888 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmbx10.600pk
  1285.      774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmsl10.600pk
  1286.      774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
  1287.      774455889 /usr/local/share/texmf/dvips/texc.pro
  1288. Only filenames that are absolute are recorded, to preserve some
  1289. semblance of privacy.
  1290. File: kpathsea.info,  Node: Common problems,  Prev: Logging,  Up: Reporting bugs
  1291. Common problems
  1292. ---------------
  1293.   Here are some common problems with configuration, compilation,
  1294. linking, execution, ...
  1295. * Menu:
  1296. * Unable to find files::        If your program can't find fonts (or whatever).
  1297. * Slow path searching::         If it takes forever to find anything.
  1298. * Unable to generate fonts::    If mktexpk fails.
  1299. * TeX or Metafont failing::     Likely compiler bugs.
  1300. * Empty Makefiles::                When configure produces empty makefiles.
  1301. * XtStrings::                   When _XtStrings is undefined.
  1302. * dlopen::                      When dlopen is undefined.
  1303. * ShellWidgetClass::            For dynamic linking troubles under OpenWindows.
  1304. * Pointer combination warnings::  For old compilers that don't grok char *.
  1305. File: kpathsea.info,  Node: Unable to find files,  Next: Slow path searching,  Up: Common problems
  1306. Unable to find files
  1307. ....................
  1308.   If a program complains it cannot find fonts (or other input files),
  1309. any of several things might be wrong.  In any case, you may find the
  1310. debugging options helpful.  *Note Debugging::.
  1311.    * Perhaps you simply haven't installed all the necessary files; the
  1312.      basic fonts and input files are distributed separately from the
  1313.      programs.  *Note unixtex.ftp::.
  1314.    * You have (perhaps unknowingly) told Kpathsea to use search paths
  1315.      that don't reflect where the files actually are.  One common cause
  1316.      is having environment variables set from a previous installation,
  1317.      thus overriding what you carefully set in `texmf.cnf' (*note
  1318.      Supported file formats::.).  System `/etc/profile' or other files
  1319.      such may be the culprit.
  1320.    * Your files reside in a directory that is only pointed to via a
  1321.      symbolic link, in a leaf directory and is not listed in `ls-R'.
  1322.      Unfortunately, Kpathsea's subdirectory searching has an
  1323.      irremediable deficiency: If a directory D being searched for
  1324.      subdirectories contains plain files and symbolic links to other
  1325.      directories, but no true subdirectories, D will be considered a
  1326.      leaf directory, i.e., the symbolic links will not be followed.
  1327.      *Note Subdirectory expansion::.
  1328.      You can work around this problem by creating an empty dummy
  1329.      subdirectory in D. Then D will no longer be a leaf, and the
  1330.      symlinks will be followed.
  1331.      The directory immediately followed by the `//' in the path
  1332.      specification, however, is always searched for subdirectories,
  1333.      even if it is a leaf.  Presumably you would not have asked for the
  1334.      directory to be searched for subdirectories if you didn't want it
  1335.      to be.
  1336.    * If the fonts (or whatever) don't already exist, `mktexpk' (or
  1337.      `mktexmf' or `mktextfm') will try to create them.  If these rather
  1338.      complicated shell scripts fail, you'll eventually get an error
  1339.      message saying something like `Can't find font FONTNAME'. The best
  1340.      solution is to fix (or at least report) the bug in `mktexpk'; the
  1341.      workaround is to generate the necessary fonts by hand with
  1342.      Metafont, or to grab them from a CTAN site (*note unixtex.ftp::.).
  1343.    * There is a bug in the library. *Note Reporting bugs::.
  1344. File: kpathsea.info,  Node: Slow path searching,  Next: Unable to generate fonts,  Prev: Unable to find files,  Up: Common problems
  1345. Slow path searching
  1346. ...................
  1347.   If your program takes an excessively long time to find fonts or other
  1348. input files, but does eventually succeed, here are some possible
  1349. culprits:
  1350.    * Most likely, you just have a lot of directories to search, and that
  1351.      takes a noticeable time. The solution is to create and maintain a
  1352.      separate `ls-R' file that lists all the files in your main TeX
  1353.      hierarchy.  *Note Filename database::.  Kpathsea always uses `ls-R'
  1354.      if it's present; there's no need to recompile or reconfigure any
  1355.      of the programs.
  1356.    * Your recursively-searched directories (e.g.,
  1357.      `/usr/local/share/texmf/fonts//'), contain a mixture of files and
  1358.      directories. This prevents Kpathsea from using a useful
  1359.      optimization (*note Subdirectory expansion::.).
  1360.      It is best to have only directories (and perhaps a `README') in the
  1361.      upper levels of the directory structure, and it's very important
  1362.      to have *only* files, and no subdirectories, in the leaf
  1363.      directories where the dozens of TFM, PK, or whatever files reside.
  1364.   In any case, you may find the debugging options helpful in determining
  1365. precisely when the disk or network is being pounded.  *Note Debugging::.
  1366. File: kpathsea.info,  Node: Unable to generate fonts,  Next: TeX or Metafont failing,  Prev: Slow path searching,  Up: Common problems
  1367. Unable to generate fonts
  1368. ........................
  1369.   This can happen if either `mktexpk' hasn't been installed properly,
  1370. or if the local installation of Metafont isn't correct.
  1371.   If `mf' is a command not found by `mktexpk', then you need to install
  1372. Metafont (*note unixtex.ftp::.).
  1373.   If Metafont runs, but generates fonts at the wrong resolution, you
  1374. need to be sure the `M' and `D' lines in your Dvips configuration file
  1375. match (*note Config files: (dvips)Config files.).  For example, if
  1376. `mktexpk' is generating 300dpi fonts, but you need 600dpi fonts, you
  1377. should have:
  1378.      M ljfour
  1379.      D 600
  1380.   If Metafont runs but generates fonts at a resolution of 2602dpi (and
  1381. prints out the name of each character as well as just a character
  1382. number, and maybe tries to display the characters), then your Metafont
  1383. base file probably hasn't been made properly.  (It's using the default
  1384. `proof' mode, instead of an actual device mode.)  To make a proper
  1385. `plain.base', assuming the local mode definitions are contained in a
  1386. file `modes.mf', run the following command (assuming Unix):
  1387.      inimf "plain; input modes; dump"
  1388. Then copy the `plain.base' file from the current directory to where the
  1389. base files are stored on your system (`/usr/local/share/texmf/web2c' by
  1390. default), and make a link (either hard or soft) from `plain.base' to
  1391. `mf.base' in that directory.  *Note inimf invocation: (web2c)inimf
  1392. invocation.
  1393. File: kpathsea.info,  Node: TeX or Metafont failing,  Next: Empty Makefiles,  Prev: Unable to generate fonts,  Up: Common problems
  1394. TeX or Metafont failing
  1395. .......................
  1396.   If TeX or Metafont get a segmentation fault or otherwise fail while
  1397. running a normal input file, the problem is usually a compiler bug
  1398. (unlikely as that may sound).  Even if the trip and trap tests are
  1399. passed, problems may lurk.  Optimization occasionally causes trouble in
  1400. programs other than TeX and Metafont themselves, too.
  1401.   Insufficient swap space may also cause core dumps or other erratic
  1402. behavior.
  1403.   For a workaround, if you enabled any optimization flags, it's best to
  1404. omit optimization entirely.  In any case, the way to find the facts is
  1405. to run the program under the debugger and see where it's failing.
  1406.   Also, if you have trouble with a system C compiler, I advise trying
  1407. the GNU C compiler. And vice versa, unfortunately; but in that case I
  1408. also recommend reporting a bug to the GCC mailing list; see *Note Bugs:
  1409. (gcc)Bugs.
  1410.   To report compiler bugs effectively requires perseverance and
  1411. perspicacity: you must find the miscompiled line, and that usually
  1412. involves delving backwards in time from the point of error, checking
  1413. through TeX's (or whatever program's) data structures.  Things are not
  1414. helped by all-too-common bugs in the debugger itself.  Good luck.
  1415.   One known cause of trouble is the way arrays are handled.  Some of the
  1416. Pascal arrays have a lower index other than 0, and the C code will take
  1417. the pointer to the allocated memory, subtract the lower index, and use
  1418. the resulting pointer for the array.  While this trick often works, ANSI
  1419. C doesn't guarantee that it will.  It it known to fail on HP-UX 10
  1420. mchines when the native compiler is used, unless the `+u' compiler
  1421. switch was specified.  Using GCC will work on this platform as well.
  1422. File: kpathsea.info,  Node: Empty Makefiles,  Next: XtStrings,  Prev: TeX or Metafont failing,  Up: Common problems
  1423. Empty Makefiles
  1424. ...............
  1425.   On some systems (NetBSD, FreeBSD, AIX 4.1, and Mach10), `configure'
  1426. may fail to properly create the Makefiles. Instead, you get an error
  1427. which looks something like this:
  1428.      prompt$ ./configure
  1429.      ...
  1430.      creating Makefile
  1431.      sed: 1: "\\@^ac_include make/pat ...": \ can not be used as a string delimiter
  1432.   So far as I know, the bug here is in `/bin/sh' on these systems. I
  1433. don't have access to a machine running any of them, so if someone can
  1434. find a workaround that avoids the quoting bug, I'd be most grateful.
  1435. (Search for `ac_include' in the `configure' script to get to the
  1436. problematic code.)
  1437.   It should work to run `bash configure', instead of using `/bin/sh'.
  1438. You can get Bash from `ftp://prep.ai.mit.edu/pub/gnu' and mirrors.
  1439.   Another possible cause (reported for NeXT) is a bug in the `sed'
  1440. command.  In that case the error may look like this:
  1441.      Unrecognized command: \@^ac_include make/paths.make@r make/paths.make
  1442.   In this case, installing GNU `sed' should solve the problem.  You can
  1443. get GNU `sed' from the same places as Bash.
  1444. File: kpathsea.info,  Node: XtStrings,  Next: dlopen,  Prev: Empty Makefiles,  Up: Common problems
  1445. `XtStrings'
  1446. ...........
  1447.   You may find that linking X programs results in an error from the
  1448. linker that `XtStrings' is undefined, something like this:
  1449.      gcc -o virmf ...
  1450.      .../x11.c:130: undefined reference to `XtStrings'
  1451.   This generally happens because of a mismatch between the X include
  1452. files with which you compiled and the X libraries with which you linked;
  1453. often, the include files are from MIT and the libraries from Sun.
  1454.   The solution is to use the same X distribution for compilation and
  1455. linking.  Probably `configure' was unable to guess the proper
  1456. directories from your installation.  You can use the `configure'
  1457. options `--x-includes=PATH' and `--x-libraries=PATH' to explicitly
  1458. specify them.
  1459. File: kpathsea.info,  Node: dlopen,  Next: ShellWidgetClass,  Prev: XtStrings,  Up: Common problems
  1460. `dlopen'
  1461. ........
  1462.   (This section adapted from the file `dlsym.c' in the X distribution.)
  1463.   The `Xlib' library uses the standard C function `wcstombs'.  Under
  1464. SunOS 4.1, `wcstombs' uses the `dlsym' interface defined in `libdl.so'.
  1465. Unfortunately, the SunOS 4.1 distribution does not include a static
  1466. `libdl.a' library.
  1467.   As a result, if you try to link an X program statically under SunOS,
  1468. you may get undefined references to `dlopen', `dlsym', and `dlclose'.
  1469. One workaround is to include these definitions when you link:
  1470.      void *dlopen() { return 0; }
  1471.      void *dlsym()  { return 0; }
  1472.      int dlclose()  { return -1; }
  1473. These are contained in the `dlsym.c' file in the MIT X distribution.
  1474. File: kpathsea.info,  Node: ShellWidgetClass,  Next: Pointer combination warnings,  Prev: dlopen,  Up: Common problems
  1475. `ShellWidgetClass'
  1476. ..................
  1477.   (This section adapted from the comp.sys.sun.admin FAQ.)
  1478.   If you are linking with Sun's OpenWindows libraries in SunOS 4.1.x,
  1479. you may get undefined symbols `_get_wmShellWidgetClass' and
  1480. `_get_applicationShellWidgetClass' when linking. This problem does not
  1481. arise using the standard MIT X libraries under SunOS.
  1482.   The cause is bugs in the `Xmu' shared library as shipped from Sun.
  1483. There are several fixes:
  1484.    * Install the free MIT distribution from `ftp.x.org' and mirrors.
  1485.    * Get the OpenWindows patches listed below.
  1486.    * Statically link the `Xmu' library into the executable.
  1487.    * Avoid using `Xmu' at all. If you are compiling Metafont, see *Note
  1488.      Online Metafont graphics: (web2c)Online Metafont graphics. If you
  1489.      are compiling Xdvi, see the `-DNOTOOL' option in `xdvik/INSTALL'.
  1490.    * Ignore the errors. The binary runs fine regardless.
  1491.   Here is the information for getting the two patches:
  1492.      Patch ID: 100512-02
  1493.      Bug ID's: 1086793, 1086912, 1074766
  1494.      Description: 4.1.x OpenWindows 3.0 `libXt' jumbo patch
  1495.      
  1496.      Patch ID: 100573-03
  1497.      Bug ID: 1087332
  1498.      Description: 4.1.x OpenWindows 3.0 undefined symbols when using shared `libXmu'.
  1499.   The way to statically link with `libXmu' depends on whether you are
  1500. using a Sun compiler (e.g., `cc') or `gcc'. If the latter, alter the
  1501. `x_libs' Make variable to include
  1502.      -static -lXmu -dynamic
  1503.   If you are using the Sun compiler, use `-Bstatic' and `-Bdynamic'.
  1504. File: kpathsea.info,  Node: Pointer combination warnings,  Prev: ShellWidgetClass,  Up: Common problems
  1505. Pointer combination warnings
  1506. ............................
  1507.   When compiling with old C compilers, you may get some warnings about
  1508. "illegal pointer combinations".  These are spurious; just ignore them.
  1509. I decline to clutter up the source with casts to get rid of them.
  1510. File: kpathsea.info,  Node: Path searching,  Next: TeX support,  Prev: Installation,  Up: Top
  1511. Path searching
  1512. **************
  1513.   This chapter describes the generic path searching mechanism Kpathsea
  1514. provides.  For information about searching for particular file types
  1515. (e.g., TeX fonts), see the next chapter.
  1516. * Menu:
  1517. * Searching overview::          Basic scheme for searching.
  1518. * Path sources::                Where search paths can be defined.
  1519. * Path expansion::              Special constructs in search paths.
  1520. * Filename database::           Using an externally-built list to search.
  1521. * Invoking kpsewhich::          Standalone path lookup.
  1522. File: kpathsea.info,  Node: Searching overview,  Next: Path sources,  Up: Path searching
  1523. Searching overview
  1524. ==================
  1525.   A "search path" is a colon-separated list of "path elements", which
  1526. are directory names with a few extra frills.  A search path can come
  1527. from (a combination of) many sources; see below.  To look up a file
  1528. `foo' along a path `.:/dir', Kpathsea checks each element of the path
  1529. in turn: first `./foo', then `/dir/foo', returning the first match (or
  1530. possibly all matches).
  1531.   The "colon" and "slash" mentioned here aren't necessarily `:' and `/'
  1532. on non-Unix systems.  Kpathsea tries to adapt to other operating
  1533. systems' conventions.
  1534.   To check a particular path element E, Kpathsea first sees if a
  1535. prebuilt database (*note Filename database::.) applies to E, i.e., if
  1536. the database is in a directory that is a prefix of E.  If so, the path
  1537. specification is matched against the contents of the database.
  1538.   If the database does not exist, or does not apply to this path
  1539. element, or contains no matches, the filesystem is searched (if this
  1540. was not forbidden by the specification with `!!' and if the file being
  1541. searched for must exist).  Kpathsea constructs the list of directories
  1542. that correspond to this path element, and then checks in each for the
  1543. file being searched for.  (To help speed future lookups of files in the
  1544. same directory, the directory in which a file is found is floated to the
  1545. top of the directory list.)
  1546.   The "file must exist" condition comes into play with VF files and
  1547. input files read by the TeX `\openin' command.  These files may not
  1548. exist (consider `cmr10.vf'), and so it would be wrong to search the
  1549. disk for them.  Therefore, if you fail to update `ls-R' when you
  1550. install a new VF file, it will never be found.
  1551.   Each path element is checked in turn: first the database, then the
  1552. disk.  If a match is found, the search stops and the result is
  1553. returned.  This avoids possibly-expensive processing of path
  1554. specifications that are never needed on a particular run.  (Unless the
  1555. search explicitly requested all matches.)
  1556.   Although the simplest and most common path element is a directory
  1557. name, Kpathsea supports additional features in search paths: layered
  1558. default values, environment variable names, config file values, users'
  1559. home directories, and recursive subdirectory searching.  Thus, we say
  1560. that Kpathsea "expands" a path element, meaning transforming all the
  1561. magic specifications into the basic directory name or names.  This
  1562. process is described in the sections below.  It happens in the same
  1563. order as the sections.
  1564.   Exception to all of the above: If the filename being searched for is
  1565. absolute or explicitly relative, i.e., starts with `/' or `./' or
  1566. `../', Kpathsea simply checks if that file exists.
  1567.   Ordinarily, if Kpathsea tries to access a file or directory that
  1568. cannot be read, it gives a warning.  This is so you will be alerted to
  1569. directories or files that accidentally lack read permission (for
  1570. example, a `lost+found').  If you prefer not to see these warnings,
  1571. include the value `readable' in the `TEX_HUSH' environment variable or
  1572. config file value.
  1573.   This generic path searching algorithm is implemented in
  1574. `kpathsea/pathsearch.c'.  It is employed by a higher-level algorithm
  1575. when searching for a file of a particular type (*note File lookup::.,
  1576. and *Note Glyph lookup::).
  1577. File: kpathsea.info,  Node: Path sources,  Next: Path expansion,  Prev: Searching overview,  Up: Path searching
  1578. Path sources
  1579. ============
  1580.   A search path can come from many sources.  In the order in which
  1581. Kpathsea uses them:
  1582.   1. A user-set environment variable, e.g., `TEXINPUTS'.  Environment
  1583.      variables with an underscore and the program name appended
  1584.      override; for example, `TEXINPUTS_latex' overrides `TEXINPUTS' if
  1585.      the program being run is named `latex'.
  1586.   2. A program-specific configuration file, e.g., an `S /a:/b' line in
  1587.      Dvips' `config.ps' (*note Config files: (dvips)Config files.).
  1588.   3. A line in a Kpathsea configuration file `texmf.cnf', e.g.,
  1589.      `TEXINPUTS=/c:/d' (see below).
  1590.   4. The compile-time default (specified in `kpathsea/paths.h').
  1591.   You can see each of these values for a given search path by using the
  1592. debugging options (*note Debugging::.).
  1593.   These sources may be combined via default expansion (*note Default
  1594. expansion::.).
  1595. * Menu:
  1596. * Config files::        Kpathsea's runtime config files (texmf.cnf).
  1597. File: kpathsea.info,  Node: Config files,  Up: Path sources
  1598. Config files
  1599. ------------
  1600.   As mentioned above, Kpathsea reads "runtime configuration files"
  1601. named `texmf.cnf' for search path and other definitions.  The search
  1602. path used to look for these configuration files is named `TEXMFCNF',
  1603. and is constructed in the usual way, as described above, except that
  1604. configuration files cannot be used to define the path, naturally; also,
  1605. an `ls-R' database is not used to search for them.
  1606.   Kpathsea reads *all* `texmf.cnf' files in the search path, not just
  1607. the first one found; definitions in earlier files override those in
  1608. later files.  Thus, if the search path is `.:$TEXMF', values from
  1609. `./texmf.cnf' override those from `$TEXMF/texmf.cnf'.
  1610.   While (or instead of) reading this description, you may find it
  1611. helpful to look at the distributed `texmf.cnf', which uses or at least
  1612. mentions most features.  The format of `texmf.cnf' files follows:
  1613.    * Comments start with `%' and continue to the end of the line.
  1614.    * Blank lines are ignored.
  1615.    * A `\' at the end of a line acts as a continuation character, i.e.,
  1616.      the next line is appended.  Whitespace at the beginning of
  1617.      continuation lines is not ignored.
  1618.    * Each remaining line must look like
  1619.           VARIABLE [. PROGNAME] [=] VALUE
  1620.      where the `=' and surrounding whitespace is optional.
  1621.    * The VARIABLE name may contain any character other than whitespace,
  1622.      `=', or `.', but sticking to `A-Za-z_' is safest.
  1623.    * If `.PROGNAME' is present, the definition only applies if the
  1624.      program that is running is named (i.e., the last component of
  1625.      `argv[0]' is) PROGNAME or `PROGNAME.exe'.  This allows different
  1626.      flavors of TeX to have different search paths, for example.
  1627.    * VALUE may contain any characters except `%' and `@'.  (These
  1628.      restrictions are only necessary because of the processing done on
  1629.      `texmf.cnf' at build time, so you can stick those characters in
  1630.      after installation if you have to.)  The `$VAR.PROG' feature is
  1631.      not available on the right-hand side; instead, you must use an
  1632.      additional variable (see below for example).  A `;' in VALUE is
  1633.      translated to `:' if running under Unix; this is useful to write a
  1634.      single `texmf.cnf' which can be used under both Unix and NT.  (If
  1635.      you really want `;''s in your filenames, add
  1636.      `-DALLOW_SEMICOLON_IN_FILENAMES' to `CFLAGS'.)
  1637.    * All definitions are read before anything is expanded, so you can
  1638.      use variables before they are defined (like Make, unlike most other
  1639.      programs).
  1640. Here is a configuration file fragment illustrating most of these points:
  1641.      % TeX input files -- i.e., anything to be found by \input or \openin ...
  1642.      latex209_inputs = .:$TEXMF/tex/latex209//:$TEXMF/tex//
  1643.      latex2e_inputs = .:$TEXMF/tex/latex//:$TEXMF/tex//
  1644.      TEXINPUTS = .:$TEXMF/tex//
  1645.      TEXINPUTS.latex209 = $latex209_inputs
  1646.      TEXINPUTS.latex2e = $latex2e_inputs
  1647.      TEXINPUTS.latex = $latex2e_inputs
  1648.   Although this format has obvious similarities to Bourne shell
  1649. scripts--change the comment character to `#', disallow spaces around
  1650. the `=', and get rid of the `.NAME' convention, and it could be run
  1651. through the shell.  But there seemed little advantage to doing this,
  1652. since all the information would have to passed back to Kpathsea and
  1653. parsed there anyway, since the `sh' process couldn't affect its
  1654. parent's environment.
  1655.   The implementation of all this is in `kpathsea/cnf.c'.
  1656. File: kpathsea.info,  Node: Path expansion,  Next: Filename database,  Prev: Path sources,  Up: Path searching
  1657. Path expansion
  1658. ==============
  1659.   Kpathsea recognizes certain special characters and constructions in
  1660. search paths, similar to that in shells.  As a general example:
  1661. `~$USER/{foo,bar}//baz' expands to all subdirectories under directories
  1662. `foo' and `bar' in $USER's home directory that contain a directory or
  1663. file `baz'.  These expansions are explained in the sections below.
  1664. * Menu:
  1665. * Default expansion::           a: or :a or a::b expands to a default.
  1666. * Variable expansion::          $foo and ${foo} expand to environment values.
  1667. * Tilde expansion::             ~ and ~user expand to home directories.
  1668. * Brace expansion::             a{foo,bar}b expands to afoob abarb.
  1669. * KPSE_DOT expansion::          . is replaced with $KPSE_DOT if it is defined.
  1670. * Subdirectory expansion::      a// and a//b recursively expand to subdirs.
  1671. File: kpathsea.info,  Node: Default expansion,  Next: Variable expansion,  Up: Path expansion
  1672. Default expansion
  1673. -----------------
  1674.   If the highest-priority search path (*note Path sources::.) contains
  1675. an "extra colon" (i.e., leading, trailing, or doubled), Kpathsea
  1676. inserts at that point the next-highest-priority search path that is
  1677. defined.  If that inserted path has an extra colon, the same happens
  1678. with the next-highest.  (An extra colon in the compile-time default
  1679. value has unpredictable results, so installers beware.)
  1680.   For example, given an environment variable setting
  1681.      setenv TEXINPUTS /home/karl:
  1682. and a `TEXINPUTS' value from `texmf.cnf' of
  1683.      .:$TEXMF//tex
  1684. then the final value used for searching will be:
  1685.      /home/karl:.:$TEXMF//tex
  1686.   Since Kpathsea looks for multiple configuration files, it would be
  1687. natural to expect that (for example) an extra colon in `./texmf.cnf'
  1688. would expand to the path in `$TEXMF/texmf.cnf'.  Or, with Dvips'
  1689. configuration files, that an extra colon in `config.$PRINTER' would
  1690. expand to the path in `config.ps'.  This doesn't happen.  It's not
  1691. clear this would be desirable in all cases, and trying to devise a way
  1692. to specify the path to which the extra colon should expand seemed truly
  1693. baroque.
  1694.   Technicality: Since it would be useless to insert the default value in
  1695. more than one place, Kpathsea changes only one extra `:' and leaves any
  1696. others in place (they will eventually be ignored).  Kpathsea checks
  1697. first for a leading `:', then a trailing `:', then a doubled `:'.
  1698.   You can trace this by debugging "paths" (*note Debugging::.).
  1699. Default expansion is implemented in the source file
  1700. `kpathsea/kdefault.c'.
  1701. File: kpathsea.info,  Node: Variable expansion,  Next: Tilde expansion,  Prev: Default expansion,  Up: Path expansion
  1702. Variable expansion
  1703. ------------------
  1704.   `$foo' or `${foo}' in a path element is replaced by (1) the value of
  1705. an environment variable `foo' (if defined); (2) the value of `foo' from
  1706. `texmf.cnf' (if defined); (3) the empty string.
  1707.   If the character after the `$' is alphanumeric or `_', the variable
  1708. name consists of all consecutive such characters. If the character
  1709. after the `$' is a `{', the variable name consists of everything up to
  1710. the next `}' (braces may not be nested around variable names).
  1711. Otherwise, Kpathsea gives a warning and ignores the `$' and its
  1712. following character.
  1713.   You must quote the $'s and braces as necessary for your shell.
  1714. *Shell* variable values cannot be seen by Kpathsea, i.e., ones defined
  1715. by `set' in C shells and without `export' in Bourne shells.
  1716.   For example, given
  1717.      setenv tex /home/texmf
  1718.      setenv TEXINPUTS .:$tex:${tex}prev
  1719.    the final `TEXINPUTS' path is the three directories:
  1720.      .:/home/texmf:/home/texmfprev
  1721.   The `.PROGNAME' suffix on variables and `_PROGNAME' on environment
  1722. variable names are not implemented for general variable expansions.
  1723. These are only recognized when search paths are initialized (*note Path
  1724. sources::.).
  1725.   Variable expansion is implemented in the source file
  1726. `kpathsea/variable.c'.
  1727. File: kpathsea.info,  Node: Tilde expansion,  Next: Brace expansion,  Prev: Variable expansion,  Up: Path expansion
  1728. Tilde expansion
  1729. ---------------
  1730.   A leading `~' in a path element is replaced by the value of the
  1731. environment variable `HOME', or `.' if `HOME' is not set.
  1732.   A leading `~USER' in a path element is replaced by USER's home
  1733. directory from the system `passwd' database.
  1734.   For example,
  1735.      setenv TEXINPUTS ~/mymacros:
  1736. will prepend a directory `mymacros' in your home directory to the
  1737. default path.
  1738.   As a special case, if a home directory ends in `/', the trailing
  1739. slash is dropped, to avoid inadvertently creating a `//' construct in
  1740. the path.  For example, if the home directory of the user `root' is
  1741. `/', the path element `~root/mymacros' expands to just `/mymacros', not
  1742. `//mymacros'.
  1743.   Tilde expansion is implemented in the source file `kpathsea/tilde.c'.
  1744. File: kpathsea.info,  Node: Brace expansion,  Next: KPSE_DOT expansion,  Prev: Tilde expansion,  Up: Path expansion
  1745. Brace expansion
  1746. ---------------
  1747.   `x{A,B}y' expands to `xAy:xBy'.  For example:
  1748.      foo/{1,2}/baz
  1749. expands to `foo/1/baz:foo/2/baz'.  `:' is the path separator on the
  1750. current system; e.g., on a DOS system, it's `;'.
  1751.   Braces can be nested; for example, `x{A,B{1,2}}y' expands to
  1752. `xAy:xB1y:xB2y'.
  1753.   Multiple non-nested braces are expanded from right to left; for
  1754. example, `x{A,B}{1,2}y' expands to `x{A,B}1y:x{A,B}2y', which expands
  1755. to `xA1y:xB1y:xA2y:xB2:y'.
  1756.   This feature can be used to implement multiple TeX hierarchies, by
  1757. assigning a brace list to `$TEXMF', as mentioned in `texmf.in'.
  1758.   You can also use the path separator in stead of the comma.  The last
  1759. example could have been written `x{A:B}{1:2}y'.
  1760.   Brace expansion is implemented in the source file
  1761. `kpathsea/expand.c'.  It is a modification of the Bash sources, and is
  1762. thus covered by the GNU General Public License, rather than the Library
  1763. General Public License that covers the rest of Kpathsea.
  1764. File: kpathsea.info,  Node: KPSE_DOT expansion,  Next: Subdirectory expansion,  Prev: Brace expansion,  Up: Path expansion
  1765. `KPSE_DOT' expansion
  1766. --------------------
  1767.   When `KPSE_DOT' is defined in the environment, it names a directory
  1768. that should be considered the current directory for the purpose of
  1769. looking up files in the search paths.  This feature is needed by the
  1770. `mktex...' scripts *Note mktex scripts::, because these change the
  1771. working directory.  You should not ever define it yourself.
  1772. File: kpathsea.info,  Node: Subdirectory expansion,  Prev: KPSE_DOT expansion,  Up: Path expansion
  1773. Subdirectory expansion
  1774. ----------------------
  1775.   Two or more consecutive slashes in a path element following a
  1776. directory D is replaced by all subdirectories of D: first those
  1777. subdirectories directly under D, then the subsubdirectories under
  1778. those, and so on.  At each level, the order in which the directories are
  1779. searched is unspecified.  (It's "directory order", and definitely not
  1780. alphabetical.)
  1781.   If you specify any filename components after the `//', only
  1782. subdirectories which match those components are included.  For example,
  1783. `/a//b' would expand into directories `/a/1/b', `/a/2/b', `/a/1/1/b',
  1784. and so on, but not `/a/b/c' or `/a/1'.
  1785.   You can include multiple `//' constructs in the path.
  1786.   `//' at the beginning of a path is ignored; you didn't really want to
  1787. search every directory on the system, did you?
  1788.   I should mention one related implementation trick, which I took from
  1789. GNU find.  Matthew Farwell suggested it, and David MacKenzie
  1790. implemented it.
  1791.   The trick is that in every real Unix implementation (as opposed to the
  1792. POSIX specification), a directory which contains no subdirectories will
  1793. have exactly two links (namely, one for `.' and one for `..').  That is
  1794. to say, the `st_nlink' field in the `stat' structure will be two.
  1795. Thus, we don't have to stat everything in the bottom-level (leaf)
  1796. directories--we can just check `st_nlink', notice it's two, and do no
  1797. more work.
  1798.   But if you have a directory that contains a single subdirectory and
  1799. 500 regular files, `st_nlink' will be 3, and Kpathsea has to stat every
  1800. one of those 501 entries.  Therein lies slowness.
  1801.   You can disable the trick by undefining `UNIX_ST_LINK' in
  1802. `kpathsea/config.h'. (It is undefined by default except under Unix.)
  1803.   Unfortunately, in some cases files in leaf directories are `stat''d:
  1804. if the path specification is, say, `$TEXMF/fonts//pk//', then files in
  1805. a subdirectory `.../pk', even if it is a leaf, are checked. The reason
  1806. cannot be explained without reference to the implementation, so read
  1807. `kpathsea/elt-dirs.c' (search for `may descend') if you are curious.
  1808. And if you can find a way to *solve* the problem, please let me know.
  1809.   Subdirectory expansion is implemented in the source file
  1810. `kpathsea/elt-dirs.c'.
  1811. File: kpathsea.info,  Node: Filename database,  Next: Invoking kpsewhich,  Prev: Path expansion,  Up: Path searching
  1812. Filename database (`ls-R')
  1813. ==========================
  1814.   Kpathsea goes to some lengths to minimize disk accesses for searches
  1815. (*note Subdirectory expansion::.).  Nevertheless, at installations with
  1816. enough directories, searching each possible directory for a given file
  1817. can take an excessively long time (depending on the speed of the disk,
  1818. whether it's NFS-mounted, how patient you are, etc.).
  1819.   In practice, a font tree containing the standard PostScript and PCL
  1820. fonts is large enough for searching to be noticeably slow on typical
  1821. systems these days.  Therefore, Kpathsea can use an externally-built
  1822. "database" file named `ls-R' that maps files to directories, thus
  1823. avoiding the need to exhaustively search the disk.
  1824.   A second database file `aliases' allows you to give additional names
  1825. to the files listed in `ls-R'.  This can be helpful to adapt to "8.3"
  1826. filename conventions in source files.
  1827.   The `ls-R' and `aliases' features are implemented in the source file
  1828. `kpathsea/db.c'.
  1829. * Menu:
  1830. * ls-R::                        The main filename database.
  1831. * Filename aliases::            Aliases for those names.
  1832. * Database format::             Syntax details of the database file.
  1833. File: kpathsea.info,  Node: ls-R,  Next: Filename aliases,  Up: Filename database
  1834. `ls-R'
  1835. ------
  1836.   As mentioned above, you must name the main filename database `ls-R'.
  1837. You can put one at the root of each TeX installation hierarchy you wish
  1838. to search (`$TEXMF' by default); most sites have only one hierarchy.
  1839. Kpathsea looks for `ls-R' files along the `TEXMFDBS' path, so that
  1840. should presumably match the list of hierarchies.
  1841.   The recommended way to create and maintain `ls-R' is to run the
  1842. `mktexlsr' script, which is installed in `$(bindir)' (`/usr/local/bin'
  1843. by default).  That script goes to some trouble to follow symbolic links
  1844. as necessary, etc.  It's also invoked by the distributed `mktex...'
  1845. scripts.
  1846.   At its simplest, though, you can build `ls-R' with the command
  1847.      cd /YOUR/TEXMF/ROOT && ls -LAR ./ >ls-R
  1848. presuming your `ls' produces the right output format (see the section
  1849. below).  GNU `ls', for example, outputs in this format.  Also presuming
  1850. your `ls' hasn't been aliased in a system file (e.g., `/etc/profile')
  1851. to something problematic, e.g., `ls --color=tty'.  In that case, you
  1852. will have to disable the alias before generating `ls-R'.  For the
  1853. precise definition of the file format, see *Note Database format::.
  1854.   Regardless of whether you use the supplied script or your own, you
  1855. will almost certainly want to invoke it via `cron', so when you make
  1856. changes in the installed files (say if you install a new LaTeX
  1857. package), `ls-R' will be automatically updated.
  1858.   The `-A' option to `ls' includes files beginning with `.'  (except
  1859. for `.' and `..'), such as the file `.tex' included with the LaTeX
  1860. tools package.  (On the other hand, *directories* whose names begin
  1861. with `.' are always ignored.)
  1862.   If your system does not support symbolic links, omit the `-L'.
  1863.   `ls -LAR /YOUR/TEXMF/ROOT' will also work.  But using `./' avoids
  1864. embedding absolute pathnames, so the hierarchy can be easily
  1865. transported.  It also avoids possible trouble with automounters or
  1866. other network filesystem conventions.
  1867.   Kpathsea warns you if it finds an `ls-R' file, but the file does not
  1868. contain any usable entries.  The usual culprit is running plain `ls -R'
  1869. instead of `ls -LR ./' or `ls -R /YOUR/TEXMF/ROOT'.  Another
  1870. possibility is some system directory name starting with a `.' (perhaps
  1871. if you are using AFS); Kpathsea ignores everything under such
  1872. directories.
  1873.   Because the database may be out-of-date for a particular run, if a
  1874. file is not found in the database, by default Kpathsea goes ahead and
  1875. searches the disk. If a particular path element begins with `!!',
  1876. however, *only* the database will be searched for that element, never
  1877. the disk.  If the database does not exist, nothing will be searched.
  1878. Because this can surprise users ("I see the font `foo.tfm' when I do an
  1879. `ls'; why can't Dvips find it?"), it is not in any of the default
  1880. search paths.
  1881. File: kpathsea.info,  Node: Filename aliases,  Next: Database format,  Prev: ls-R,  Up: Filename database
  1882. Filename aliases
  1883. ----------------
  1884.   In some circumstances, you may wish to find a file under several
  1885. names.  For example, suppose a TeX document was created using a DOS
  1886. system and tries to read `longtabl.sty'.  But now it's being run on a
  1887. Unix system, and the file has its original name, `longtable.sty'.  The
  1888. file won't be found.  You need to give the actual file `longtable.sty'
  1889. an alias `longtabl.sty'.
  1890.   You can handle this by creating a file `aliases' as a companion to
  1891. the `ls-R' for the hierarchy containing the file in question.  (You
  1892. must have an `ls-R' for the alias feature to work.)
  1893.   The format of `aliases' is simple: two whitespace-separated words per
  1894. line; the first is the real name `longtable.sty', and second is the
  1895. alias (`longtabl.sty').  These must be base filenames, with no
  1896. directory components.  `longtable.sty' must be in the sibling `ls-R'.
  1897.   Also, blank lines and lines starting with `%' or `#' are ignored in
  1898. `aliases', to allow for comments.
  1899.   If a real file `longtabl.sty' exists, it is used regardless of any
  1900. aliases.
  1901. File: kpathsea.info,  Node: Database format,  Prev: Filename aliases,  Up: Filename database
  1902. Database format
  1903. ---------------
  1904.   The "database" read by Kpathsea is a line-oriented file of plain
  1905. text. The format is that generated by GNU (and most other) `ls'
  1906. programs given the `-R' option, as follows.
  1907.    * Blank lines are ignored.
  1908.    * If a line begins with `/' or `./' or `../' and ends with a colon,
  1909.      it's the name of a directory.  (`../' lines aren't useful,
  1910.      however, and should not be generated.)
  1911.    * All other lines define entries in the most recently seen directory.
  1912.      /'s in such lines will produce possibly-strange results.
  1913.    * Files with no preceding directory line are ignored.
  1914.   For example, here's the first few lines of `ls-R' (which totals about
  1915. 30K bytes) on my system:
  1916.      bibtex
  1917.      dvips
  1918.      fonts
  1919.      ls-R
  1920.      metafont
  1921.      metapost
  1922.      tex
  1923.      web2c
  1924.      
  1925.      ./bibtex:
  1926.      bib
  1927.      bst
  1928.      doc
  1929.      
  1930.      ./bibtex/bib:
  1931.      asi.bib
  1932.      btxdoc.bib
  1933.      ...
  1934. File: kpathsea.info,  Node: Invoking kpsewhich,  Prev: Filename database,  Up: Path searching
  1935. `kpsewhich': Standalone path searching
  1936. ======================================
  1937.   The Kpsewhich program exercises the path searching functionality
  1938. independent of any particular application.  This can also be useful as a
  1939. sort of `find' program to locate files in your TeX hierarchies, perhaps
  1940. in administrative scripts.  It is used heavily in the distributed
  1941. `mktex...' scripts.
  1942.   Synopsis:
  1943.      kpsewhich OPTION... FILENAME...
  1944.   The options and filename(s) to look up can be intermixed.  Options
  1945. can start with either `-' or `--', and any unambiguous abbreviation is
  1946. accepted.
  1947. * Menu:
  1948. * Path searching options::      Changing the mode, resolution, etc.
  1949. * Auxiliary tasks::             Path and variable expansion.
  1950. * Standard options::            -help and -version.
  1951. File: kpathsea.info,  Node: Path searching options,  Next: Auxiliary tasks,  Up: Invoking kpsewhich
  1952. Path searching options
  1953. ----------------------
  1954.   Kpsewhich looks up each non-option argument on the command line as a
  1955. filename, and returns the first file found.  There is no option to
  1956. return all the files with a particular name (you can run the Unix
  1957. `find' utility for that, *note Invoking find: (findutils)Invoking
  1958. find.).
  1959.   Various options alter the path searching behavior:
  1960. `--dpi=NUM'
  1961.      Set the resolution to NUM; this only affects `gf' and `pk'
  1962.      lookups.  `-D' is a synonym, for compatibility with Dvips.
  1963.      Default is 600.
  1964. `--format=NAME'
  1965.      Set the format for lookup to NAME.  By default, the format is
  1966.      guessed from the filename, with `tex' being used if nothing else
  1967.      fits.  The recognized filename extensions (including any leading
  1968.      `.') are also allowable NAMEs.
  1969.      All formats also have a name, which is the only way to specify
  1970.      formats with no associated suffix.  For example, for Dvips
  1971.      configuration files you can use `--format="dvips config"'.  (The
  1972.      quotes are for the sake of the shell.)
  1973.      Here's the current list of recognized names and the associated
  1974.      suffixes.  *Note Supported file formats::, for more information on
  1975.      each of these.
  1976.           gf: gf
  1977.           pk: pk
  1978.           bitmap font
  1979.           afm: .afm
  1980.           base: .base
  1981.           bib: .bib
  1982.           bst: .bst
  1983.           cnf: .cnf
  1984.           ls-R: ls-R
  1985.           fmt: .fmt
  1986.           map: .map
  1987.           mem: .mem
  1988.           mf: .mf
  1989.           mfpool: .pool
  1990.           mft: .mft
  1991.           mp: .mp
  1992.           mppool: .pool
  1993.           MetaPost support
  1994.           ocp: .ocp
  1995.           ofm: .ofm .tfm
  1996.           opl: .opl
  1997.           otp: .otp
  1998.           ovf: .ovf
  1999.           ovp: .ovp
  2000.           graphic/figure: .eps .epsi
  2001.           tex: .tex
  2002.           TeX system documentation
  2003.           texpool: .pool
  2004.           TeX system sources
  2005.           PostScript header/font: .pro
  2006.           Troff fonts
  2007.           tfm: .tfm
  2008.           type1 fonts: .pfa .pfb
  2009.           vf: .vf
  2010.           dvips config
  2011.           ist: .ist
  2012.           truetype fonts: .ttf .ttc
  2013.           type42 fonts
  2014.           web2c files
  2015.           other text files
  2016.           other binary files
  2017.      This option and `--path' are mutually exclusive.
  2018. `--interactive'
  2019.      After processing the command line, read additional filenames to
  2020.      look up from standard input.
  2021. `-mktex=FILETYPE'
  2022. `-no-mktex=FILETYPE'
  2023.      Turn on or off the `mktex' script associated with FILETYPE.  The
  2024.      only values that make sense for FILETYPE are `pk', `mf', `tex',
  2025.      and `tfm'. By default, all are off in Kpsewhich.  *Note mktex
  2026.      scripts::.
  2027. `--mode=STRING'
  2028.      Set the mode name to STRING; this also only affects `gf' and `pk'
  2029.      lookups.  No default: any mode will be found.  *Note mktex script
  2030.      arguments::.
  2031. `--must-exist'
  2032.      Do everything possible to find the files, notably including
  2033.      searching the disk.  By default, only the `ls-R' database is
  2034.      checked, in the interest of efficiency.
  2035. `--path=STRING'
  2036.      Search along the path STRING (colon-separated as usual), instead
  2037.      of guessing the search path from the filename.  `//' and all the
  2038.      usual expansions are supported (*note Path expansion::.).  This
  2039.      option and `--format' are mutually exclusive.  To output the
  2040.      complete directory expansion of a path, instead of doing a
  2041.      one-shot lookup, see `--expand-path' in the following section.
  2042. `--progname=NAME'
  2043.      Set the program name to NAME; default is `kpsewhich'.  This can
  2044.      affect the search paths via the `.PROGNAM' feature in
  2045.      configuration files (*note Config files::.).
  2046. File: kpathsea.info,  Node: Auxiliary tasks,  Next: Standard options,  Prev: Path searching options,  Up: Invoking kpsewhich
  2047. Auxiliary tasks
  2048. ---------------
  2049.   Kpsewhich provides some additional features not strictly related to
  2050. path lookup:
  2051.    * `--debug=NUM' sets the debugging options to NUM.  *Note
  2052.      Debugging::.
  2053.    * `--expand-braces=STRING' outputs the variable and brace expansion
  2054.      of STRING.  *Note Path expansion::.
  2055.    * `--expand-var=STRING' outputs the variable expansion of STRING.
  2056.      For example, the `mktex...' scripts run `kpsewhich
  2057.      --expand-var='$TEXMF'' to find the root of the TeX system
  2058.      hierarchy.  *Note Path expansion::.
  2059.    * `--expand-path=STRING' outputs the complete expansion of STRING as
  2060.      a colon-separated path.  This is useful to construct a search path
  2061.      for a program that doesn't accept recursive subdirectory
  2062.      specifications.
  2063.      For one-shot uses of an arbitrary (not built in to Kpathsea) path,
  2064.      see `--path' in the previous section.
  2065.    * `--show-path=NAME' shows the path that would be used for file
  2066.      lookups of file type NAME.  Either a filename extension (`pk',
  2067.      `.vf', etc.) or an integer can be used, just as with `--format',
  2068.      described in the previous section.
  2069. File: kpathsea.info,  Node: Standard options,  Prev: Auxiliary tasks,  Up: Invoking kpsewhich
  2070. Standard options
  2071. ----------------
  2072.   Kpsewhich accepts the standard GNU options:
  2073.    * `--help' prints a help message on standard output and exits.
  2074.    * `--version' prints the Kpathsea version number and exits.
  2075. File: kpathsea.info,  Node: TeX support,  Next: Programming,  Prev: Path searching,  Up: Top
  2076. TeX support
  2077. ***********
  2078.   Although the basic features in Kpathsea can be used for any type of
  2079. path searching, it came about (like all libraries) with a specific
  2080. application in mind: I wrote Kpathsea specifically for TeX system
  2081. programs.  I had been struggling with the programs I was using (Dvips,
  2082. Xdvi, and TeX itself) having slightly different notions of how to
  2083. specify paths; and debugging was painful, since no code was shared.
  2084.   Therefore, Kpathsea provides some TeX-specific formats and features.
  2085. Indeed, many of the supposedly generic path searching features were
  2086. provided because they seemed useful in that conTeXt (font lookup,
  2087. particularly).
  2088.   Kpathsea provides a standard way to search for files of any of the
  2089. supported file types; glyph fonts are a bit different than all the rest.
  2090. Searches are based solely on filenames, not file contents--if a GF file
  2091. is named `cmr10.600pk', it will be found as a PK file.
  2092. * Menu:
  2093. * Supported file formats::      File types Kpathsea knows about.
  2094. * File lookup::                 Searching for most kinds of files.
  2095. * Glyph lookup::                Searching for bitmap fonts.
  2096. * Suppressing warnings::        Avoiding warnings via TEX_HUSH.
  2097. File: kpathsea.info,  Node: Supported file formats,  Next: File lookup,  Up: TeX support
  2098. Supported file formats
  2099. ======================
  2100.   Kpathsea has support for a number of file types.  Each file type has a
  2101. list of environment and config file variables that are checked to define
  2102. the search path, and most have a default suffix that plays a role in
  2103. finding files (see the next section).  Some also define additional
  2104. suffixes, and/or a program to be run to create missing files on the fly.
  2105.   Since environment variables containing periods, such as
  2106. `TEXINPUTS.latex', are not allowed on some systems, Kpathsea looks for
  2107. environment variables with an underscore, e.g., `TEXINPUTS_latex'
  2108. (*note Config files::.).
  2109.   The following table lists the above information.
  2110. `afm'
  2111.      (Adobe font metrics, *note Metric files: (dvips)Metric files.)
  2112.      `AFMFONTS'; suffix `.afm'.
  2113. `base'
  2114.      (Metafont memory dump, *note Memory dumps: (web2c)Memory dumps.)
  2115.      `MFBASES', `TEXMFINI'; suffix `.base'.
  2116. `bib'
  2117.      (BibTeX bibliography source, *note bibtex invocation:
  2118.      (web2c)bibtex invocation.)  `BIBINPUTS', `TEXBIB'; suffix `.bib'.
  2119. `bst'
  2120.      (BibTeX style file, *note Basic BibTeX style files: (web2c)Basic
  2121.      BibTeX style files.)  `BSTINPUTS'; suffix `.bst'.
  2122. `cnf'
  2123.      (Runtime configuration files, *note Config files::.)  `TEXMFCNF';
  2124.      suffix `.cnf'.
  2125. `dvips config'
  2126.      (Dvips `config.*' files, such as `config.ps', *note Config files:
  2127.      (dvips)Config files.)  `TEXCONFIG'.
  2128. `fmt'
  2129.      (TeX memory dump, *note Memory dumps: (web2c)Memory dumps.)
  2130.      `TEXFORMATS', `TEXMFINI'; suffix `.fmt'.
  2131.      (generic font bitmap, *note Glyph files: (dvips)Glyph files.)
  2132.      `PROGRAMFONTS', `GFFONTS', `GLYPHFONTS', `TEXFONTS'; suffix `gf'.
  2133. `graphic/figure'
  2134.      (Encapsulated PostScript figures, *note PostScript figures:
  2135.      (dvips)PostScript figures.)  `TEXPICTS', `TEXINPUTS'; additional
  2136.      suffixes: `.eps', `.epsi'.
  2137. `ist'
  2138.      (makeindex style files) `TEXINDEXSTYLE', `INDEXSTYLE'; suffix
  2139.      `.ist'.
  2140. `ls-R'
  2141.      (Filename databases, *note Filename database::.)  `TEXMFDBS'.
  2142. `map'
  2143.      (Fontmaps, *note Fontmap::.)  `TEXFONTMAPS'; suffix `.map'.
  2144. `mem'
  2145.      (MetaPost memory dump, *note Memory dumps: (web2c)Memory dumps.)
  2146.      `MPMEMS', `TEXMFINI'; suffix `.mem'.
  2147. `MetaPost support'
  2148.      (MetaPost support files, used by DMP; *note dmp invocation:
  2149.      (web2c)dmp invocation.)  `MPSUPPORT'.
  2150.      (Metafont source, *note mf invocation: (web2c)mf invocation.)
  2151.      `MFINPUTS'; suffix `.mf'; dynamic creation program: `mktexmf'.
  2152. `mfpool'
  2153.      (Metafont program strings, *note pooltype invocation:
  2154.      (web2c)pooltype invocation.)  `MFPOOL', `TEXMFINI'; suffix `.pool'.
  2155. `mft'
  2156.      (`MFT' style file, *note mft invocation: (web2c)mft invocation.)
  2157.      `MFTINPUTS'; suffix `.mft'.
  2158.      (MetaPost source, *note mpost invocation: (web2c)mpost invocation.)
  2159.      `MPINPUTS'; suffix `.mp'.
  2160. `mppool'
  2161.      (MetaPost program strings, *note pooltype invocation:
  2162.      (web2c)pooltype invocation.)  `MPPOOL', `TEXMFINI'; suffix `.pool'.
  2163. `ocp'
  2164.      (Omega compiled process files) `OCPINPUTS';
  2165.      suffix `.ocp'; dynamic creation program: `MakeOmegaOCP'.
  2166. `ofm'
  2167.      (Omega font metrics) `OFMFONTS', `TEXFONTS';
  2168.      suffixes `.ofm', `.tfm'; dynamic creation program: `MakeOmegaOFM'.
  2169. `opl'
  2170.      (Omega property lists) `OPLFONTS', `TEXFONTS'; suffix `.opl'.
  2171. `otp'
  2172.      (Omega translation process files) `OTPINPUTS'; suffix `.otp'.
  2173. `ovf'
  2174.      (Omega virtual fonts) `OVFFONTS', `TEXFONTS'; suffix `.ovf'.
  2175. `ovp'
  2176.      (Omega virtual property lists) `OVPFONTS', `TEXFONTS'; suffix
  2177.      `.ovp'.
  2178.      (packed bitmap fonts, *note Glyph files: (dvips)Glyph files.)
  2179.      `PROGRAMFONTS' (PROGRAM being `XDVI', etc.), `PKFONTS', `TEXPKS',
  2180.      `GLYPHFONTS', `TEXFONTS'; suffix `pk'; dynamic creation program:
  2181.      `mktexpk'.
  2182. `PostScript header'
  2183.      (downloadable PostScript, *note Header files: (dvips)Header files.)
  2184.      `TEXPSHEADERS', `PSHEADERS'; additional suffix `.pro'.
  2185. `tex'
  2186.      (TeX source, *note tex invocation: (web2c)tex invocation.)
  2187.      `TEXINPUTS'; suffix `.tex'; additional suffixes: none, because
  2188.      such a list cannot be complete; dynamic creation program:
  2189.      `mktextex'.
  2190. `TeX system documentation'
  2191.      (Documentation files for the TeX system) `TEXDOCS'.
  2192. `TeX system sources'
  2193.      (Source files for the TeX system) `TEXSOURCES'.
  2194. `texpool'
  2195.      (TeX program strings, *note pooltype invocation: (web2c)pooltype
  2196.      invocation.)  `TEXPOOL', `TEXMFINI'; suffix `.pool'.
  2197. `tfm'
  2198.      (TeX font metrics, *note Metric files: (dvips)Metric files.)
  2199.      `TFMFONTS', `TEXFONTS'; suffix `.tfm'; dynamic creation program:
  2200.      `mktextfm'.
  2201. `Troff fonts'
  2202.      (Troff fonts, used by DMP; *note DMP invocation: (web2c)DMP
  2203.      invocation.)  `TRFONTS'.
  2204. `truetype fonts'
  2205.      (TrueType outline fonts) `TTFONTS'; suffixes `.ttf', `.ttc'.
  2206. `type1 fonts'
  2207.      (Type 1 PostScript outline fonts, *note Glyph files: (dvips)Glyph
  2208.      files.)  `T1FONTS', `T1INPUTS', `TEXPSHEADERS', `DVIPSHEADERS';
  2209.      suffixes `.pfa', `.pfb'.
  2210. `type42 fonts'
  2211.      (Type 42 PostScript outline fonts) `T42FONTS'.
  2212.      (virtual fonts, *note Virtual fonts: (dvips)Virtual fonts.)
  2213.      `VFFONTS', `TEXFONTS'; suffix `.vf'.
  2214.   There are two special cases, because the paths and environment
  2215. variables always depend on the name of the program: the variable name is
  2216. constructed by converting the program name to upper case, and then
  2217. appending `INPUTS'.  Assuming the program is called `foo', this gives
  2218. us the following table.
  2219. `other text files'
  2220.      (text files used by `foo') `FOOINPUTS'.
  2221. `other binary files'
  2222.      (binary files used by `foo') `FOOINPUTS'.
  2223.   If an environment variable by these names are set, the corresponding
  2224. `texmf.cnf' definition won't be looked at (unless, as usual, the
  2225. environment variable value has an extra `:').  *Note Default
  2226. expansion::.
  2227.   For the font variables, the intent is that:
  2228.    * `TEXFONTS' is the default for everything.
  2229.    * `GLYPHFONTS' is the default for bitmap (or, more precisely,
  2230.      non-metric) files.
  2231.    * Each font format has a variable of its own.
  2232.    * Each program has its own font override path as well; e.g.,
  2233.      `DVIPSFONTS' for Dvipsk.  Again, this is for bitmaps, not metrics.
  2234. File: kpathsea.info,  Node: File lookup,  Next: Glyph lookup,  Prev: Supported file formats,  Up: TeX support
  2235. File lookup
  2236. ===========
  2237.   This section describes how Kpathsea searches for most files (bitmap
  2238. font searches are the exception, as described in the next section).
  2239.   Here is the search strategy for a file NAME:
  2240.   1. If the file format defines default suffixes, and the suffix of
  2241.      NAME name is not already a known suffix for that format, try the
  2242.      name with each default appended, and use alternative names found
  2243.      in the fontmaps if necessary.  We postpone searching the disk as
  2244.      long as possible.  Example: given `foo.sty', look for `foo.sty.tex'
  2245.      before `foo.sty'.  This is unfortunate, but allows us to find
  2246.      `foo.bar.tex' before `foo.bar' if both exist and we were given
  2247.      `foo.bar'.
  2248.   2. Search for NAME, and if necssary for alternative names found in
  2249.      the fontmaps.  Again we avoid searching the disk if possible.
  2250.      Example: given `foo', we look for `foo'.
  2251.   3. If the file format defines a program to invoke to create missing
  2252.      files, run it (*note mktex scripts::.).
  2253.   This is implemented in the routine `kpse_find_file' in
  2254. `kpathsea/tex-file.c'.  You can watch it in action with the debugging
  2255. options (*note Debugging::.).
  2256. File: kpathsea.info,  Node: Glyph lookup,  Next: Suppressing warnings,  Prev: File lookup,  Up: TeX support
  2257. Glyph lookup
  2258. ============
  2259.   This section describes how Kpathsea searches for a bitmap font in GF
  2260. or PK format (or either) given a font name (e.g., `cmr10') and a
  2261. resolution (e.g., 600).
  2262.   Here is an outline of the search strategy (details in the sections
  2263. below) for a file NAME at resolution DPI.  The search stops at the
  2264. first successful lookup.
  2265.   1. Look for an existing file NAME.DPIFORMAT in the specified
  2266.      format(s).
  2267.   2. If NAME is an alias for a file F in the fontmap file
  2268.      `texfonts.map', look for F.DPI.
  2269.   3. Run an external program (typically named `mktexpk') to generate
  2270.      the font (*note mktex scripts::.)
  2271.   4. Look for FALLBACK.DPI, where FALLBACK is some last-resort font
  2272.      (typically `cmr10').
  2273.   This is implemented in `kpse_find_glyph_format' in
  2274. `kpathsea/tex-glyph.c'.
  2275. * Menu:
  2276. * Basic glyph lookup::          Features common to all glyph lookups.
  2277. * Fontmap::                     Aliases for fonts.
  2278. * Fallback font::               Resolutions and fonts of last resort.
  2279. File: kpathsea.info,  Node: Basic glyph lookup,  Next: Fontmap,  Up: Glyph lookup
  2280. Basic glyph lookup
  2281. ------------------
  2282.   When Kpathsea looks for a bitmap font NAME at resolution DPI in a
  2283. format FORMAT, it first checks each directory in the search path for a
  2284. file `NAME.DPIFORMAT'; for example, `cmr10.600pk'.  Kpathsea looks for
  2285. a PK file first, then a GF file.
  2286.   If that fails, Kpathsea looks for `dpiDPI/NAME.FORMAT'; for example,
  2287. `dpi600/cmr10.pk'. This is how fonts are typically stored on
  2288. filesystems (such as DOS) that permit only three-character extensions.
  2289.   If that fails, Kpathsea looks for a font with a close-enough DPI.
  2290. "Close enough" is defined by the macro `KPSE_BITMAP_TOLERANCE' in
  2291. `kpathsea/tex-glyph.h' to be `DPI / 500 + 1'.  This is slightly more
  2292. than the 0.2% minimum allowed by the DVI standard
  2293. (`CTAN:/dviware/driv-standard/level-0').
  2294. File: kpathsea.info,  Node: Fontmap,  Next: Fallback font,  Prev: Basic glyph lookup,  Up: Glyph lookup
  2295. Fontmap
  2296. -------
  2297.   If a bitmap font or metric file is not found with the original name
  2298. (see the previous section), Kpathsea looks through any "fontmap" files
  2299. for an "alias" for the original font name.  These files are named
  2300. `texfonts.map' and searched for along the `TEXFONTMAPS'
  2301. environment/config file variable.  All `texfonts.map' files that are
  2302. found are read; earlier definitions override later ones.
  2303.   This feature is intended to help in two respects:
  2304.   1. An alias name is limited in length only by available memory, not
  2305.      by your filesystem.  Therefore, if you want to ask for
  2306.      `Times-Roman' instead of `ptmr', you can (you get `ptmr8r').
  2307.   2. A few fonts have historically had multiple names: specifically,
  2308.      LaTeX's "circle font" has variously been known as `circle10',
  2309.      `lcircle10', and `lcirc10'.  Aliases can make all the names
  2310.      equivalent, so that it no longer matters what the name of the
  2311.      installed file is; TeX documents will find their favorite name.
  2312.   The format of fontmap files is straightforward:
  2313.    * Comments start with `%' and continue to the end of the line.
  2314.    * Blank lines are ignored.
  2315.    * Each nonblank line is broken up into a series of "words":   a
  2316.      sequence of non-whitespace characters.
  2317.    * If the first word is `include', the second word is used as   a
  2318.      filename, and it is searched for and read.
  2319.    * Otherwise, the first word on each line is the true filename;
  2320.    * the second word is the alias;
  2321.    * subsequent words are ignored.
  2322.   If an alias has an extension, it matches only those files with that
  2323. extension; otherwise, it matches anything with the same root, regardless
  2324. of extension.  For example, an alias `foo.tfm' matches only when
  2325. `foo.tfm' is being searched for; but an alias `foo' matches `foo.vf',
  2326. `foo.600pk', etc.
  2327.   As an example, here is an excerpt from the `texfonts.map' in the
  2328. Web2c distribution.  It makes the circle fonts equivalent and includes
  2329. automatically generated maps for most PostScript fonts available from
  2330. various font suppliers.
  2331.      circle10        lcircle10
  2332.      circle10        lcirc10
  2333.      lcircle10       circle10
  2334.      lcircle10       lcirc10
  2335.      lcirc10         circle10
  2336.      lcirc10         lcircle10
  2337.      ...
  2338.      include adobe.map
  2339.      include apple.map
  2340.      include bitstrea.map
  2341.      ...
  2342.   Fontmaps are implemented in the file `kpathsea/fontmap.c'.  The
  2343. Fontname distribution has much more information on font naming (*note
  2344. Introduction: (fontname)Introduction.).
  2345. File: kpathsea.info,  Node: Fallback font,  Prev: Fontmap,  Up: Glyph lookup
  2346. Fallback font
  2347. -------------
  2348.   If a bitmap font cannot be found or created at the requested size,
  2349. Kpathsea looks for the font at a set of "fallback resolutions".  You
  2350. specify these resolutions as a colon-separated list (like search paths).
  2351. Kpathsea looks first for a program-specific environment variable (e.g.,
  2352. `DVIPSSIZES' for Dvipsk), then the environment variable `TEXSIZES',
  2353. then a default specified at compilation time (the Make variable
  2354. `default_texsizes').  You can set this list to be empty if you prefer
  2355. to find fonts at their stated size or not at all.
  2356.   Finally, if the font cannot be found even at the fallback resolutions,
  2357. Kpathsea looks for a fallback font, typically `cmr10'.  Programs must
  2358. enable this feature by assigning to the global variable
  2359. `kpse_fallback_font' or calling `kpse_init_prog' (*note Calling
  2360. sequence::.); the default is no fallback font.
  2361. File: kpathsea.info,  Node: Suppressing warnings,  Prev: Glyph lookup,  Up: TeX support
  2362. Suppressing warnings
  2363. ====================
  2364.   Kpathsea provides a way to suppress selected usually-harmless
  2365. warnings; this is useful at large sites where most users are not
  2366. administrators, and thus the warnings are merely a source of confusion,
  2367. not a help.  To do this, you set the environment variable or
  2368. configuration file value `TEX_HUSH' to a colon-separated list of
  2369. values.  Here are the possibilities:
  2370. `all'
  2371.      Suppress everything possible.
  2372. `checksum'
  2373.      Suppress mismatched font checksum warnings.
  2374. `lostchar'
  2375.      Suppress warnings when a character is missing from a font that a
  2376.      DVI or VF file tries to typeset.
  2377. `readable'
  2378.      Suppress warnings about attempts to access a file whose permissions
  2379.      render it unreadable.
  2380. `special'
  2381.      Suppresses warnings about an unimplemented or unparsable
  2382.      `\special' command.
  2383. `tex-hush.c' defines the function that checks the variable value.  Each
  2384. driver implements its own checks where appropriate.
  2385. File: kpathsea.info,  Node: Programming,  Next: Index,  Prev: TeX support,  Up: Top
  2386. Programming
  2387. ***********
  2388.   This chapter is for programmers who wish to use Kpathsea.  *Note
  2389. Introduction::, for the conditions under which you may do so.
  2390. * Menu:
  2391. * Overview: Programming overview.         Introduction.
  2392. * Calling sequence::                      Specifics of what to call.
  2393. * Program-specific files::                How to handle these.
  2394. * Config: Programming with config files.  Getting info from texmf.cnf.
  2395. File: kpathsea.info,  Node: Programming overview,  Next: Calling sequence,  Up: Programming
  2396. Programming overview
  2397. ====================
  2398.   Aside from this manual, your best source of information is the source
  2399. to the programs I've modified to use Kpathsea (*note Introduction::.).
  2400. Of those, Dviljk is probably the simplest, and hence a good place to
  2401. start.  Xdvik adds VF support and the complication of X resources.
  2402. Dvipsk adds the complication of its own config files.  Web2c is source
  2403. code I also maintain, so it uses Kpathsea rather straightforwardly, but
  2404. is of course complicated by the Web to C translation.  Finally,
  2405. Kpsewhich is a small utility program whose sole purpose is to exercise
  2406. the main path-searching functionality.
  2407.   Beyond these examples, the `.h' files in the Kpathsea source describe
  2408. the interfaces and functionality (and of course the `.c' files define
  2409. the actual routines, which are the ultimate documentation).
  2410. `pathsearch.h' declares the basic searching routine.  `tex-file.h' and
  2411. `tex-glyph.h' define the interfaces for looking up particular kinds of
  2412. files.  You may wish to use `#include <kpathsea/kpathsea.h>', which
  2413. includes every Kpathsea header.
  2414.   The library provides no way for an external program to register new
  2415. file types: `tex-file.[ch]' must be modified to do this. For example,
  2416. Kpathsea has support for looking up Dvips config files, even though no
  2417. program other than Dvips will likely ever want to do so.  I felt this
  2418. was acceptable, since along with new file types should also come new
  2419. defaults in `texmf.cnf' (and its descendant `paths.h'), since it's
  2420. simplest for users if they can modify one configuration file for all
  2421. kinds of paths.
  2422.   Kpathsea does not parse any formats itself; it barely opens any files.
  2423. Its primary purpose is to return filenames.  The GNU font utilities does
  2424. contain libraries to read TFM, GF, and PK files, as do the programs
  2425. above, of course.
  2426. File: kpathsea.info,  Node: Calling sequence,  Next: Program-specific files,  Prev: Programming overview,  Up: Programming
  2427. Calling sequence
  2428. ================
  2429.   The typical way to use Kpathsea in your program goes something like
  2430. this:
  2431.   1. Call `kpse_set_program_name' with `argv[0]' as the first argument;
  2432.      the second argument is a string or `NULL'.  The second argument is
  2433.      used by Kpathsea as the program name for the `.PROGRAM' feature of
  2434.      config files (*note Config files::.).  If the second argument is
  2435.      `NULL', the value of the first argument is used.  This function
  2436.      must be called before any other use of the Kpathsea library.
  2437.      If necessary, `kpse_set_program_name' sets the global variables
  2438.      `program_invocation_name' and `program_invocation_short_name'.
  2439.      These variables are used in the error message macros defined in
  2440.      `kpathsea/lib.h'.  It sets the global variable `kpse_program_name'
  2441.      to the program name it uses.  It also initializes debugging
  2442.      options based on the environment variable `KPATHSEA_DEBUG' (if
  2443.      that is set).  Finally, it sets the variables `SELFAUTOLOC',
  2444.      `SELFAUTODIR' and `SELFAUTOPARENT' to the location, parent and
  2445.      grandparent directory of the executable, removing `.' and `..'
  2446.      path elements and resolving symbolic links.  These are used in the
  2447.      default configuration file to allow people to invoke TeX from
  2448.      anywhere, specifically from a mounted CD-ROM.  (You can use
  2449.      `--expand-var=\$SELFAUTOLOC', etc., to see the values finds.)
  2450.   2. The `kpse_set_progname' is deprecated.  A call to
  2451.      `kpse_set_progname' with `argv[0]' is equivalent to a call of
  2452.      `kpse_set_program_name' with first argument `argv[0]' and second
  2453.      argument `NULL'.  The function is deprecated because it cannot
  2454.      ensure that the `.PROGRAM' feature of config files will always
  2455.      work (*note Config files::.).
  2456.   3. Set debugging options. *Note Debugging::.  If your program doesn't
  2457.      have a debugging option already, you can define one and set
  2458.      `kpathsea_debug' to the number that the user supplies (as in Dviljk
  2459.      and Web2c), or you can just omit this altogether (people can
  2460.      always set `KPATHSEA_DEBUG').  If you do have runtime debugging
  2461.      already, you need to merge Kpathsea's options with yours (as in
  2462.      Dvipsk and Xdvik).
  2463.   4. If your program has its own configuration files that can define
  2464.      search paths, you should assign those paths to the `client_path'
  2465.      member in the appropriate element of the `kpse_format_info' array.
  2466.      (This array is indexed by file type; see `tex-file.h'.)  See
  2467.      `resident.c' in Dvipsk for an example.
  2468.   5. Call `kpse_init_prog' (see `proginit.c'). It's useful for the DVI
  2469.      drivers, at least, but for other programs it may be simpler to
  2470.      extract the parts of it that actually apply.  This does not
  2471.      initialize any paths, it just looks for (and sets) certain
  2472.      environment variables and other random information.  (A search
  2473.      path is always initialized at the first call to find a file of
  2474.      that type; this eliminates much useless work, e.g., initializing
  2475.      the BibTeX search paths in a DVI driver.)
  2476.   6. The routine to actually find a file of type FORMAT is
  2477.      `kpse_find_FORMAT', defined in `tex-file.h'. These are macros that
  2478.      expand to a call to `kpse_find_file'.  You can call, say,
  2479.      `kpse_find_tfm' after doing only the first of the initialization
  2480.      steps above--Kpathsea automatically reads the `texmf.cnf' generic
  2481.      config files, looks for environment variables, and does expansions
  2482.      at the first lookup.
  2483.   7. To find PK and/or GF bitmap fonts, the routines are `kpse_find_pk',
  2484.      `kpse_find_gf' and `kpse_find_glyph', defined in `tex-glyph.h'.
  2485.      These return a structure in addition to the resultant filename,
  2486.      because fonts can be found in so many ways. See the documentation
  2487.      in the source.
  2488.   8. To actually open a file, not just return a filename, call
  2489.      `kpse_open_file'.  This function takes the name to look up and a
  2490.      Kpathsea file format as arguments, and returns the usual `FILE *'.
  2491.      It always assumes the file must exist, and thus will search the
  2492.      disk if necessary (unless the search path specified `!!', etc.).
  2493.      In other words, if you are looking up a VF or some other file that
  2494.      need not exist, don't use this.
  2495.   Kpathsea also provides many utility routines. Some are generic: hash
  2496. tables, memory allocation, string concatenation and copying, string
  2497. lists, reading input lines of arbitrary length, etc. Others are
  2498. filename-related: default path, tilde, and variable expansion, `stat'
  2499. calls, etc. (Perhaps someday I'll move the former to a separate
  2500. library.)
  2501.   The `c-*.h' header files can also help your program adapt to many
  2502. different systems.  You will almost certainly want to use Autoconf for
  2503. configuring your software if you use Kpathsea; I strongly recommend
  2504. using Autoconf regardless.  It is available from
  2505. `ftp://prep.ai.mit.edu/pub/gnu/'.
  2506. File: kpathsea.info,  Node: Program-specific files,  Next: Programming with config files,  Prev: Calling sequence,  Up: Programming
  2507. Program-specific files
  2508. ======================
  2509.   Many programs will need to find some configuration files.  Kpathsea
  2510. contains some support to make it easy to place them in their own
  2511. directories.  The Standard TeX directory structure (*note Introduction:
  2512. (tds)Top.), specifies that such files should go into a subdirectory
  2513. named after the program, like `texmf/ttf2pk'.
  2514.   Two special formats, `kpse_program_text_format' and
  2515. `kpse_program_binary_format' exist, which use `.:$TEXMF/PROGRAM//' as
  2516. their compiled-in search path.  To override this default, you can use
  2517. the variable `PROGRAMINPUTS' in the environment and/or `texmf.cnf'.
  2518. That is to say, the name of the variable is constructed by converting
  2519. the name of the program to upper case, and appending `INPUTS'.
  2520.   The only difference between these two formats is whether
  2521. `kpse_open_file' will open the files it finds in text or binary mode.
  2522. File: kpathsea.info,  Node: Programming with config files,  Prev: Program-specific files,  Up: Programming
  2523. Programming with config files
  2524. =============================
  2525.   You can (and probably should) use the same `texmf.cnf' configuration
  2526. file that Kpathsea uses for your program.  This helps installers by
  2527. keeping all configuration in one place.
  2528.   To retrieve a value VAR from config files, the best way is to call
  2529. `kpse_var_value' on the string `VAR'.  This will look first for an
  2530. environment variable VAR, then a config file value.  The result will be
  2531. the value found or `NULL'.  This function is declared in
  2532. `kpathsea/variable.h'.  For an example, see the `shell_escape' code in
  2533. `web2c/lib/texmfmp.c'.
  2534.   The routine to do variable expansion in the context of a search path
  2535. (as opposed to simply retrieving a value) is `kpse_var_expand', also
  2536. declared in `kpathsea/variable.h'.  It's generally only necessary to
  2537. set the search path structure components as explained in the previous
  2538. section, rather than using this yourself.
  2539.   If for some reason you want to retrieve a value *only* from a config
  2540. file, not automatically looking for a corresponding environment
  2541. variable, call `kpse_cnf_get' (declared in `kpathsea/cnf.h') with the
  2542. string VAR.
  2543.   No initialization calls are needed.
  2544. File: kpathsea.info,  Node: Index,  Prev: Programming,  Up: Top
  2545. Index
  2546. *****
  2547. * Menu:
  2548. * !! in path specifications:             ls-R.
  2549. * $ expansion:                           Variable expansion.
  2550. * --color=tty:                           ls-R.
  2551. * --debug=NUM:                           Auxiliary tasks.
  2552. * --disable-static:                      configure options.
  2553. * --dpi=NUM:                             Path searching options.
  2554. * --enable options:                      configure options.
  2555. * --enable-maintainer-mode:              configure options.
  2556. * --enable-shared <1>:                   Shared library.
  2557. * --enable-shared:                       configure options.
  2558. * --expand-braces=STRING:                Auxiliary tasks.
  2559. * --expand-path=STRING:                  Auxiliary tasks.
  2560. * --expand-var=STRING:                   Auxiliary tasks.
  2561. * --format=NAME:                         Path searching options.
  2562. * --help:                                Standard options.
  2563. * --interactive:                         Path searching options.
  2564. * --mode=STRING:                         Path searching options.
  2565. * --must-exist:                          Path searching options.
  2566. * --path=STRING:                         Path searching options.
  2567. * --progname=NAME:                       Path searching options.
  2568. * --show-path=NAME:                      Auxiliary tasks.
  2569. * --srcdir, for building multiple architectures: configure scenarios.
  2570. * --version:                             Standard options.
  2571. * --with options:                        configure options.
  2572. * --with-mktextex-default:               mktex configuration.
  2573. * --without-mktexmf-default:             mktex configuration.
  2574. * --without-mktexpk-default:             mktex configuration.
  2575. * --without-mktextfm-default:            mktex configuration.
  2576. * -1 debugging value:                    Debugging.
  2577. * -A option to ls:                       ls-R.
  2578. * -Bdynamic:                             ShellWidgetClass.
  2579. * -Bstatic:                              ShellWidgetClass.
  2580. * -D NUM:                                Path searching options.
  2581. * -dynamic:                              ShellWidgetClass.
  2582. * -g, compiling without:                 configure scenarios.
  2583. * -L option to ls:                       ls-R.
  2584. * -mktex=FILETYPE:                       Path searching options.
  2585. * -no-mktex=FILETYPE:                    Path searching options.
  2586. * -O, compiling with:                    configure scenarios.
  2587. * -static:                               ShellWidgetClass.
  2588. * . directories, ignored:                ls-R.
  2589. * . files:                               ls-R.
  2590. * .2602gf:                               Unable to generate fonts.
  2591. * .afm:                                  Supported file formats.
  2592. * .base:                                 Supported file formats.
  2593. * .bib:                                  Supported file formats.
  2594. * .bst:                                  Supported file formats.
  2595. * .cnf:                                  Supported file formats.
  2596. * .eps:                                  Supported file formats.
  2597. * .epsi:                                 Supported file formats.
  2598. * .fmt:                                  Supported file formats.
  2599. * .ist:                                  Supported file formats.
  2600. * .map:                                  Supported file formats.
  2601. * .mem:                                  Supported file formats.
  2602. * .mf:                                   Supported file formats.
  2603. * .mft:                                  Supported file formats.
  2604. * .mp:                                   Supported file formats.
  2605. * .ocp:                                  Supported file formats.
  2606. * .ofm:                                  Supported file formats.
  2607. * .opl:                                  Supported file formats.
  2608. * .otp:                                  Supported file formats.
  2609. * .ovf:                                  Supported file formats.
  2610. * .ovp:                                  Supported file formats.
  2611. * .pfa:                                  Supported file formats.
  2612. * .pfb:                                  Supported file formats.
  2613. * .pk:                                   Supported file formats.
  2614. * .pool:                                 Supported file formats.
  2615. * .pro:                                  Supported file formats.
  2616. * .rhosts, writable by TeX:              Security.
  2617. * .tex:                                  Supported file formats.
  2618. * .tex file, included in ls-R:           ls-R.
  2619. * .tfm:                                  Supported file formats.
  2620. * .ttc:                                  Supported file formats.
  2621. * .ttf:                                  Supported file formats.
  2622. * .vf:                                   Supported file formats.
  2623. * / may not be /:                        Searching overview.
  2624. * /, trailing in home directory:         Tilde expansion.
  2625. * //:                                    Subdirectory expansion.
  2626. * /afs/... , installing into:            Installing files.
  2627. * /etc/profile:                          Unable to find files.
  2628. * /etc/profile and aliases:              ls-R.
  2629. * /var/tmp/texfonts:                     mktex configuration.
  2630. * 2602gf:                                Unable to generate fonts.
  2631. * 4allTeX Live CD-ROM:                   CD-ROM distribution.
  2632. * 8.3 filenames, using:                  mktex configuration.
  2633. * : may not be ::                        Searching overview.
  2634. * :: expansion:                          Default expansion.
  2635. * @VAR@ substitutions:                   Running configure.
  2636. * \, line continuation in texmf.cnf:     Config files.
  2637. * \openin:                               Searching overview.
  2638. * \special, suppressing warnings about:  Suppressing warnings.
  2639. * absolute filenames:                    Searching overview.
  2640. * ac_include, Autoconf extension:        Running configure.
  2641. * access warnings:                       Searching overview.
  2642. * Acorn TeX implementations:             Other TeX packages.
  2643. * AFMFONTS:                              Supported file formats.
  2644. * AFS:                                   Installing files.
  2645. * AIX 4.1 configure error:               Empty Makefiles.
  2646. * AIX shells and configure:              configure shells.
  2647. * aliases for fonts:                     Fontmap.
  2648. * aliases, for filenames:                Filename aliases.
  2649. * all:                                   Suppressing warnings.
  2650. * alphabetical order, not:               Subdirectory expansion.
  2651. * Amiga support:                         Custom installation.
  2652. * Amiga TeX implementations:             Other TeX packages.
  2653. * Andrew File System, installing with:   Installing files.
  2654. * announcement mailing list:             Mailing lists.
  2655. * ANSI C:                                TeX or Metafont failing.
  2656. * append-only directories and mktexpk:   Security.
  2657. * appendonlydir:                         mktex configuration.
  2658. * architecture-(in)dependent files, installing only: Installing files.
  2659. * architectures, compiling multiple:     configure scenarios.
  2660. * arguments to mktex:                    mktex script arguments.
  2661. * argv[0]:                               Calling sequence.
  2662. * ash, losing with configure:            configure shells.
  2663. * autoconf, recommended:                 Calling sequence.
  2664. * automounter, and configuration:        configure scenarios.
  2665. * automounter, and ls-R:                 ls-R.
  2666. * auxiliary tasks:                       Auxiliary tasks.
  2667. * Babel <1>:                             Running make.
  2668. * Babel:                                 Kpathsea application distributions.
  2669. * Bach, Johann Sebastian:                Default expansion.
  2670. * backbone of CTAN:                      Electronic distribution.
  2671. * backslash-newline:                     Config files.
  2672. * bash, recommended for running configure: configure shells.
  2673. * basic glyph lookup:                    Basic glyph lookup.
  2674. * Berry, Karl:                           History.
  2675. * BIBINPUTS:                             Supported file formats.
  2676. * binary mode, for file transfers:       Electronic distribution.
  2677. * blank lines, in texmf.cnf:             Config files.
  2678. * brace expansion:                       Brace expansion.
  2679. * BSD universe:                          Running make.
  2680. * bsh, ok with configure:                configure shells.
  2681. * BSTINPUTS:                             Supported file formats.
  2682. * bug address:                           Reporting bugs.
  2683. * bug checklist:                         Bug checklist.
  2684. * bug mailing list:                      Mailing lists.
  2685. * bugs, reporting:                       Reporting bugs.
  2686. * c-*.h:                                 Calling sequence.
  2687. * c-auto.in:                             Running configure.
  2688. * cache of fonts, local:                 Security.
  2689. * calling sequence:                      Calling sequence.
  2690. * CC:                                    configure environment.
  2691. * cc warnings:                           Pointer combination warnings.
  2692. * cc, compiling with:                    configure environment.
  2693. * CD-ROM distributions:                  CD-ROM distribution.
  2694. * CFLAGS:                                configure environment.
  2695. * ChangeLog entry:                       Bug checklist.
  2696. * checklist for bug reports:             Bug checklist.
  2697. * checksum:                              Suppressing warnings.
  2698. * circle fonts:                          Fontmap.
  2699. * clean Make target:                     Cleaning up.
  2700. * client_path in kpse_format_info:       Calling sequence.
  2701. * cmr10, as fallback font:               Fallback font.
  2702. * cmr10.vf:                              Searching overview.
  2703. * cnf.c:                                 Config files.
  2704. * cnf.h:                                 Programming with config files.
  2705. * code sharing:                          Shared library.
  2706. * color printers, configuring:           Simple installation.
  2707. * comments, in fontmap files:            Fontmap.
  2708. * comments, in texmf.cnf:                Config files.
  2709. * comments, making:                      Introduction.
  2710. * common features in glyph lookup:       Basic glyph lookup.
  2711. * common problems:                       Common problems.
  2712. * comp.sys.sun.admin FAQ:                ShellWidgetClass.
  2713. * comp.text.tex:                         Mailing lists.
  2714. * compilation:                           Installation.
  2715. * compilation value, source for path:    Path sources.
  2716. * compiler bugs:                         TeX or Metafont failing.
  2717. * compiler bugs, finding:                TeX or Metafont failing.
  2718. * compiler options, additional:          Running make.
  2719. * compiler options, specifying:          configure environment.
  2720. * compiler, changing:                    Running make.
  2721. * compiling on HP-UX:                    TeX or Metafont failing.
  2722. * conditions for use:                    Introduction.
  2723. * config files:                          Config files.
  2724. * config files, for Kpathsea-using programs: Calling sequence.
  2725. * config files, programming with:        Programming with config files.
  2726. * config.log:                            Bug checklist.
  2727. * config.ps, search path for:            Supported file formats.
  2728. * config.status:                         Bug checklist.
  2729. * configuration:                         Installation.
  2730. * configuration bugs:                    Bug checklist.
  2731. * configuration compiler options:        configure environment.
  2732. * configuration file, source for path:   Path sources.
  2733. * configuration files as shell scripts.: Config files.
  2734. * configuration of mktex scripts:        mktex configuration.
  2735. * configuration of optional features:    configure options.
  2736. * configure error from sed:              Empty Makefiles.
  2737. * configure options:                     configure options.
  2738. * configure options for mktex scripts:   mktex configuration.
  2739. * configure, running:                    Running configure.
  2740. * context diff:                          Bug checklist.
  2741. * continuation character:                Config files.
  2742. * core dumps, reporting:                 Bug checklist.
  2743. * CPPFLAGS:                              configure environment.
  2744. * crashes, reporting:                    Bug checklist.
  2745. * CTAN, defined:                         Electronic distribution.
  2746. * CTAN.sites:                            Electronic distribution.
  2747. * custom installation:                   Custom installation.
  2748. * Dante TeX CD-ROM:                      CD-ROM distribution.
  2749. * database search:                       Searching overview.
  2750. * database, for filenames:               Filename database.
  2751. * database, format of:                   Database format.
  2752. * debug.h:                               Debugging.
  2753. * debugger:                              Bug checklist.
  2754. * debugging:                             Debugging.
  2755. * debugging options, in Kpathsea-using program: Calling sequence.
  2756. * debugging output:                      Debugging.
  2757. * debugging with -g, disabling:          configure scenarios.
  2758. * DEC shells and configure:              configure shells.
  2759. * default expansion:                     Default expansion.
  2760. * default path features:                 Default path features.
  2761. * default paths, changing:               Default path generation.
  2762. * default paths, how they're made:       Default path generation.
  2763. * default_texsizes:                      Fallback font.
  2764. * DEFS:                                  configure environment.
  2765. * depot:                                 configure scenarios.
  2766. * directories, changing default installation: Default path generation.
  2767. * directories, making append-only:       mktex configuration.
  2768. * directory permissions:                 Security.
  2769. * directory structure, for TeX files:    TeX directory structure.
  2770. * disabling mktex scripts:               mktex configuration.
  2771. * disk search:                           Searching overview.
  2772. * disk searching, avoiding:              ls-R.
  2773. * disk space, needed:                    Disk space.
  2774. * disk usage, reducing:                  Logging.
  2775. * distclean Make target:                 Cleaning up.
  2776. * distributions, compiling simultaneously: Kpathsea application distributions.
  2777. * distributions, not compiling:          Kpathsea application distributions.
  2778. * distributions, on CD-ROM:              CD-ROM distribution.
  2779. * distributions, via ftp:                Electronic distribution.
  2780. * dlclose:                               dlopen.
  2781. * dlopen:                                dlopen.
  2782. * dlsym:                                 dlopen.
  2783. * dlsym.c:                               dlopen.
  2784. * doc files:                             Supported file formats.
  2785. * DOS compatible names:                  mktex configuration.
  2786. * DOS support:                           Custom installation.
  2787. * DOS TeX implementations:               Other TeX packages.
  2788. * dosnames:                              mktex configuration.
  2789. * dot files:                             ls-R.
  2790. * doubled colons:                        Default expansion.
  2791. * dpiNNN directories:                    mktex configuration.
  2792. * DVI drivers:                           Kpathsea application distributions.
  2793. * DVILJMAKEPK:                           mktex script names.
  2794. * DVILJSIZES:                            Fallback font.
  2795. * DVIPSFONTS:                            Supported file formats.
  2796. * DVIPSHEADERS:                          Supported file formats.
  2797. * DVIPSMAKEPK:                           mktex script names.
  2798. * DVIPSSIZES:                            Fallback font.
  2799. * dynamic creation of files:             mktex scripts.
  2800. * dynamic linking problems with OpenWin libraries: ShellWidgetClass.
  2801. * EC fonts, and dynamic source creation: mktex scripts.
  2802. * elt-dirs.c:                            Subdirectory expansion.
  2803. * email CTAN access:                     Electronic distribution.
  2804. * enabling mktex scripts:                mktex configuration.
  2805. * environment variable, source for path: Path sources.
  2806. * environment variables for TeX:         Supported file formats.
  2807. * environment variables in paths:        Variable expansion.
  2808. * environment variables, old:            Unable to find files.
  2809. * epoch, seconds since:                  Logging.
  2810. * error message macros:                  Calling sequence.
  2811. * excessive startup time:                Slow path searching.
  2812. * expand.c:                              Brace expansion.
  2813. * expanding symlinks:                    Calling sequence.
  2814. * expansion, default:                    Default expansion.
  2815. * expansion, path element:               Searching overview.
  2816. * expansion, search path:                Path expansion.
  2817. * expansion, subdirectory:               Subdirectory expansion.
  2818. * expansion, tilde:                      Tilde expansion.
  2819. * expansion, variable:                   Variable expansion.
  2820. * explicitly relative filenames:         Searching overview.
  2821. * externally-built filename database:    Filename database.
  2822. * extra colons:                          Default expansion.
  2823. * extraclean Make target:                Cleaning up.
  2824. * failed mktex... script invocation:     mktex script names.
  2825. * fallback font:                         Fallback font.
  2826. * fallback resolutions:                  Fallback font.
  2827. * fallback resolutions, overriding:      Running make.
  2828. * FAQ, comp.sys.sun.admin:               ShellWidgetClass.
  2829. * FAQ, Kpathsea:                         Common problems.
  2830. * Farwell, Matthew:                      Subdirectory expansion.
  2831. * features, of default paths:            Default path features.
  2832. * file formats, supported:               Supported file formats.
  2833. * file lookup:                           File lookup.
  2834. * file permissions:                      Security.
  2835. * file types, registering new:           Programming overview.
  2836. * filename aliases:                      Filename aliases.
  2837. * filename database:                     Filename database.
  2838. * filename database generation:          Filename database generation.
  2839. * filenames, absolute or explicitly relative: Searching overview.
  2840. * files, unable to find:                 Unable to find files.
  2841. * filesystem search:                     Searching overview.
  2842. * floating directories:                  Searching overview.
  2843. * font alias files:                      Fontmap.
  2844. * font generation failures:              Unable to generate fonts.
  2845. * font of last resort:                   Fallback font.
  2846. * font set, infinite:                    mktex scripts.
  2847. * fontmap files:                         Fontmap.
  2848. * fontmaps:                              mktex configuration.
  2849. * fontname:                              mktex configuration.
  2850. * fontnames, arbitrary length:           Fontmap.
  2851. * fonts, being created:                  Simple installation.
  2852. * FOOINPUTS:                             Supported file formats.
  2853. * fopen, redefined:                      Debugging.
  2854. * format of external database:           Database format.
  2855. * Free Software Foundation:              CD-ROM distribution.
  2856. * FreeBSD configure error:               Empty Makefiles.
  2857. * FreeBSD shells and configure:          configure shells.
  2858. * FSF Source Code CD-ROM:                CD-ROM distribution.
  2859. * ftp retrieval:                         Electronic distribution.
  2860. * ftp.tug.org:                           unixtex.ftp.
  2861. * fundamental purpose of Kpathsea:       Introduction.
  2862. * gcc, compiling with:                   configure environment.
  2863. * gdb, recommended:                      Bug checklist.
  2864. * generation of filename database:       Filename database generation.
  2865. * German TeX CD info:                    CD-ROM distribution.
  2866. * get_applicationShellWidgetClass:       ShellWidgetClass.
  2867. * get_wmShellWidgetClass:                ShellWidgetClass.
  2868. * gf:                                    Supported file formats.
  2869. * GFFONTS:                               Supported file formats.
  2870. * globally writable directories:         Security.
  2871. * glyph lookup:                          Glyph lookup.
  2872. * glyph lookup bitmap tolerance:         Basic glyph lookup.
  2873. * GLYPHFONTS:                            Supported file formats.
  2874. * GNU C compiler bugs:                   TeX or Metafont failing.
  2875. * GNU General Public License:            Introduction.
  2876. * Gopher CTAN access:                    Electronic distribution.
  2877. * group-writable directories:            Security.
  2878. * GSFTOPK_DEBUG (128):                   Debugging.
  2879. * GUTenberg:                             CD-ROM distribution.
  2880. * hash table buckets, printing:          Debugging.
  2881. * hash table routines:                   Calling sequence.
  2882. * hash_summary_only variable for debugging: Debugging.
  2883. * help, mailing list for general TeX:    Mailing lists.
  2884. * HIER:                                  Default path features.
  2885. * history of Kpathsea:                   History.
  2886. * home directories in paths:             Tilde expansion.
  2887. * HOME, as ~ expansion:                  Tilde expansion.
  2888. * HP-UX, compiling on:                   TeX or Metafont failing.
  2889. * identifiers, characters valid in:      Config files.
  2890. * illegal pointer combination warnings:  Pointer combination warnings.
  2891. * include fontmap directive:             Fontmap.
  2892. * INDEXSTYLE:                            Supported file formats.
  2893. * info-tex@shsu.edu:                     Mailing lists.
  2894. * input lines, reading:                  Calling sequence.
  2895. * install-data Make target:              Installing files.
  2896. * install-exec Make target:              Installing files.
  2897. * installation:                          Installation.
  2898. * installation testing:                  Installation testing.
  2899. * installation, architecture-(in)dependent files only: Installing files.
  2900. * installation, changing default directories: Default path generation.
  2901. * installation, customized:              Custom installation.
  2902. * installation, getting executables instead of: Simple installation.
  2903. * installation, simple:                  Simple installation.
  2904. * installing files:                      Installing files.
  2905. * interactive query:                     Path searching options.
  2906. * interface, not frozen:                 Introduction.
  2907. * introduction:                          Introduction.
  2908. * kdebug::                               Debugging.
  2909. * kdefault.c:                            Default expansion.
  2910. * Knuth, Donald E.:                      History.
  2911. * Knuth, Donald E., archive of programs by: Other TeX packages.
  2912. * Knuth, Donald E., original author:     Electronic distribution.
  2913. * Korn shell, losing with configure:     configure shells.
  2914. * Kpathsea config file, source for path: Path sources.
  2915. * Kpathsea version number:               Kpathsea application distributions.
  2916. * kpathsea.h:                            Programming overview.
  2917. * kpathsea/HIER:                         Default path features.
  2918. * kpathsea/README.CONFIGURE:             Running configure.
  2919. * KPATHSEA_DEBUG:                        Calling sequence.
  2920. * kpathsea_debug:                        Debugging.
  2921. * KPATHSEA_DEBUG:                        Debugging.
  2922. * kpathsea_debug:                        Debugging.
  2923. * kpathsea_debug variable:               Calling sequence.
  2924. * KPSE_BITMAP_TOLERANCE:                 Basic glyph lookup.
  2925. * kpse_cnf_get:                          Programming with config files.
  2926. * KPSE_DEBUG_EXPAND (16):                Debugging.
  2927. * KPSE_DEBUG_FOPEN (4):                  Debugging.
  2928. * KPSE_DEBUG_HASH (2):                   Debugging.
  2929. * KPSE_DEBUG_PATHS (8):                  Debugging.
  2930. * KPSE_DEBUG_SEARCH (32):                Debugging.
  2931. * KPSE_DEBUG_STAT (1):                   Debugging.
  2932. * KPSE_DEBUG_VARS (64):                  Debugging.
  2933. * KPSE_DOT expansion:                    KPSE_DOT expansion.
  2934. * kpse_fallback_font:                    Fallback font.
  2935. * kpse_find_*:                           Calling sequence.
  2936. * kpse_find_file <1>:                    Calling sequence.
  2937. * kpse_find_file:                        File lookup.
  2938. * kpse_find_glyph_format:                Glyph lookup.
  2939. * kpse_format_info:                      Calling sequence.
  2940. * kpse_format_info_type:                 Debugging.
  2941. * kpse_init_prog:                        Calling sequence.
  2942. * kpse_init_prog, and MAKETEX_MODE:      Default path features.
  2943. * kpse_make_specs:                       mktex script names.
  2944. * kpse_open_file:                        Calling sequence.
  2945. * kpse_program_name:                     Calling sequence.
  2946. * kpse_set_progname:                     Calling sequence.
  2947. * kpse_set_program_name:                 Calling sequence.
  2948. * kpse_var_value:                        Programming with config files.
  2949. * kpsewhich:                             Invoking kpsewhich.
  2950. * Kpsewhich, and debugging:              Debugging.
  2951. * ksh, losing with configure:            configure shells.
  2952. * labrea.stanford.edu:                   Other TeX packages.
  2953. * LaserJet drive:                        Kpathsea application distributions.
  2954. * last-resort font:                      Fallback font.
  2955. * LaTeX help mailing list:               Mailing lists.
  2956. * lcircle10:                             Fontmap.
  2957. * LDFLAGS:                               configure environment.
  2958. * leading colons:                        Default expansion.
  2959. * leaf directories wrongly guessed:      Unable to find files.
  2960. * leaf directory trick:                  Subdirectory expansion.
  2961. * libdl.a:                               dlopen.
  2962. * libraries, changing:                   Running make.
  2963. * libraries, specifying additional:      configure environment.
  2964. * LIBS:                                  configure environment.
  2965. * libucb, avoiding:                      Running make.
  2966. * license for using the library:         Introduction.
  2967. * lines, reading arbitrary-length:       Calling sequence.
  2968. * Linux File System Standard:            mktex configuration.
  2969. * Linux shells and configure:            configure shells.
  2970. * Linux, using Web2c:                    CD-ROM distribution.
  2971. * lndir for building symlink trees:      configure scenarios.
  2972. * loader options:                        configure environment.
  2973. * loader options, final:                 Running make.
  2974. * loader options, initial:               Running make.
  2975. * local cache of fonts:                  Security.
  2976. * log file:                              Logging.
  2977. * logging successful searches:           Logging.
  2978. * lost+found directory:                  Searching overview.
  2979. * lostchar:                              Suppressing warnings.
  2980. * ls-R:                                  Supported file formats.
  2981. * ls-R and AFS:                          Installing files.
  2982. * ls-R database file:                    ls-R.
  2983. * ls-R, simplest build:                  ls-R.
  2984. * Mach10 configure error:                Empty Makefiles.
  2985. * Macintosh TeX implementations:         Other TeX packages.
  2986. * MacKenzie, David <1>:                  Subdirectory expansion.
  2987. * MacKenzie, David:                      History.
  2988. * magic characters:                      Searching overview.
  2989. * mailing lists:                         Mailing lists.
  2990. * maintainer-clean Make target:          Cleaning up.
  2991. * Make arguments, additional:            Running make.
  2992. * make, running:                         Running make.
  2993. * Makefile.in:                           Running configure.
  2994. * Makefiles, empty:                      Empty Makefiles.
  2995. * MAKETEX_DEBUG (512):                   Debugging.
  2996. * MAKETEX_FINE_DEBUG (1024):             Debugging.
  2997. * MAKETEX_MODE:                          Default path features.
  2998. * memory allocation routines:            Calling sequence.
  2999. * metafont driver files:                 mktex configuration.
  3000. * Metafont failures:                     TeX or Metafont failing.
  3001. * Metafont installation:                 Unable to generate fonts.
  3002. * Metafont making too-large fonts:       Unable to generate fonts.
  3003. * Metafont using the wrong resolution:   Unable to generate fonts.
  3004. * MFBASES:                               Supported file formats.
  3005. * MFINPUTS:                              Supported file formats.
  3006. * MFPOOL:                                Supported file formats.
  3007. * MFTINPUTS:                             Supported file formats.
  3008. * mirrors, FTP:                          Electronic distribution.
  3009. * mismatched checksum warnings:          Suppressing warnings.
  3010. * missfont.log:                          mktex script names.
  3011. * MISSFONT_LOG:                          mktex script names.
  3012. * missing character warnings:            Suppressing warnings.
  3013. * mktex script configuration:            mktex configuration.
  3014. * mktex script names:                    mktex script names.
  3015. * mktex scripts:                         mktex scripts.
  3016. * mktex.cnf:                             mktex configuration.
  3017. * mktex.opt:                             mktex configuration.
  3018. * mktexdir:                              mktex configuration.
  3019. * mktexmf:                               mktex script names.
  3020. * mktexpk:                               mktex script names.
  3021. * mktexpk , initial runs:                Simple installation.
  3022. * mktextex:                              mktex script names.
  3023. * mktextfm:                              mktex script names.
  3024. * mode directory, omitting:              mktex configuration.
  3025. * Morgan, Tim:                           History.
  3026. * mostlyclean Make target:               Cleaning up.
  3027. * MPINPUTS:                              Supported file formats.
  3028. * MPMEMS:                                Supported file formats.
  3029. * MPPOOL:                                Supported file formats.
  3030. * MPSUPPORT:                             Supported file formats.
  3031. * MT_FEATURES:                           mktex configuration.
  3032. * multiple architectures, compiling on:  configure scenarios.
  3033. * multiple architectures, directories for: configure scenarios.
  3034. * multiple architectures, installing on: Installing files.
  3035. * multiple TeX hierarchies:              Brace expansion.
  3036. * must exist:                            Searching overview.
  3037. * names for mktex scripts:               mktex script names.
  3038. * NetBSD configure error:                Empty Makefiles.
  3039. * NetBSD shells and configure:           configure shells.
  3040. * Neumann, Gustaf:                       History.
  3041. * newsgroup for TeX:                     Mailing lists.
  3042. * NeXT sed error:                        Empty Makefiles.
  3043. * NeXT, lacking X11:                     Kpathsea application distributions.
  3044. * NFS and ls-R:                          ls-R.
  3045. * NFS CTAN access:                       Electronic distribution.
  3046. * nomfdrivers:                           mktex configuration.
  3047. * nomode:                                mktex configuration.
  3048. * non-English typesetting:               Kpathsea application distributions.
  3049. * non-Unix operating systems:            Custom installation.
  3050. * NTG:                                   CD-ROM distribution.
  3051. * null pointers, dereferencing:          Bug checklist.
  3052. * numeric debugging values:              Debugging.
  3053. * obtaining TeX:                         unixtex.ftp.
  3054. * obtaining Web2c by ftp:                Electronic distribution.
  3055. * obtaining Web2c on CD-ROM:             CD-ROM distribution.
  3056. * OCPINPUTS:                             Supported file formats.
  3057. * OFMFONTS:                              Supported file formats.
  3058. * online Metafont display, spurious:     Unable to generate fonts.
  3059. * OpenWin libraries, dynamic linking problems: ShellWidgetClass.
  3060. * optimization caveat:                   TeX or Metafont failing.
  3061. * optimization, enabling:                configure scenarios.
  3062. * options for debugging:                 Debugging.
  3063. * options to configure:                  configure options.
  3064. * OS/2 support:                          Custom installation.
  3065. * other TeX distributions:               Other TeX packages.
  3066. * OTPINPUTS:                             Supported file formats.
  3067. * overview of path searching:            Searching overview.
  3068. * overview of programming with Kpathsea: Programming overview.
  3069. * OVFFONTS:                              Supported file formats.
  3070. * OVPFONTS:                              Supported file formats.
  3071. * patches, Sun OpenWin:                  ShellWidgetClass.
  3072. * path expansion:                        Path expansion.
  3073. * path searching:                        Path searching.
  3074. * path searching options:                Path searching options.
  3075. * path searching, overview:              Searching overview.
  3076. * path searching, standalone:            Invoking kpsewhich.
  3077. * path sources:                          Path sources.
  3078. * paths, changing default <1>:           Default path generation.
  3079. * paths, changing default:               Changing search paths.
  3080. * paths, device name included in:        Default path features.
  3081. * paths.h:                               Default path generation.
  3082. * paths.h, creating:                     Running make.
  3083. * pathsearch.h:                          Programming overview.
  3084. * pc Pascal compiler:                    History.
  3085. * PCL driver:                            Kpathsea application distributions.
  3086. * PDF generation:                        Kpathsea application distributions.
  3087. * permission denied:                     Searching overview.
  3088. * permissions, directory:                Security.
  3089. * permissions, file:                     Security.
  3090. * PKFONTS:                               Supported file formats.
  3091. * plain.base:                            Unable to generate fonts.
  3092. * pointer combination warnings:          Pointer combination warnings.
  3093. * PostScript driver:                     Kpathsea application distributions.
  3094. * PostScript fonts, additional:          Simple installation.
  3095. * precompiled executables, instead of installation: Simple installation.
  3096. * precompiled Unix binaries:             Other TeX packages.
  3097. * preprocessor options:                  configure environment.
  3098. * preprocessor options, additional:      Running make.
  3099. * Prime Time TeXcetera CD-ROM:           CD-ROM distribution.
  3100. * printer configuration files:           Simple installation.
  3101. * privacy, semblance of:                 Logging.
  3102. * problems, common:                      Common problems.
  3103. * proginit.c:                            Default path features.
  3104. * proginit.h:                            Calling sequence.
  3105. * program-varying paths:                 Supported file formats.
  3106. * program_invocation_name:               Calling sequence.
  3107. * program_invocation_short_name:         Calling sequence.
  3108. * programming overview:                  Programming overview.
  3109. * programming with config files:         Programming with config files.
  3110. * programming with Kpathsea:             Calling sequence.
  3111. * programs using the library:            Introduction.
  3112. * proof mode:                            Unable to generate fonts.
  3113. * PSHEADERS:                             Supported file formats.
  3114. * pxp Pascal preprocessor:               History.
  3115. * quoting variable values:               Variable expansion.
  3116. * readable:                              Suppressing warnings.
  3117. * reading arbitrary-length lines:        Calling sequence.
  3118. * README.CONFIGURE:                      Running configure.
  3119. * README.mirrors:                        Electronic distribution.
  3120. * recording successful searches:         Logging.
  3121. * relative filenames:                    Searching overview.
  3122. * relative filenames in ls-R:            Installing files.
  3123. * reporting bugs:                        Reporting bugs.
  3124. * resident.c:                            Calling sequence.
  3125. * resolution, setting:                   Path searching options.
  3126. * resolution, wrong:                     Unable to generate fonts.
  3127. * resolutions, last-resort:              Fallback font.
  3128. * retrieving TeX:                        unixtex.ftp.
  3129. * right-hand side of variable assignments: Config files.
  3130. * Rokicki, Tom:                          History.
  3131. * root user:                             Tilde expansion.
  3132. * runtime configuration files:           Config files.
  3133. * runtime debugging:                     Debugging.
  3134. * Sauter fonts, and dynamic source creation: mktex scripts.
  3135. * scripts for file creation:             mktex scripts.
  3136. * search path, defined:                  Searching overview.
  3137. * search paths, changing default:        Changing search paths.
  3138. * searching for files:                   File lookup.
  3139. * searching for glyphs:                  Glyph lookup.
  3140. * searching overview:                    Searching overview.
  3141. * searching the database:                Searching overview.
  3142. * searching the disk:                    Searching overview.
  3143. * security considerations:               Security.
  3144. * sed error from configure:              Empty Makefiles.
  3145. * SELFAUTODIR:                           Calling sequence.
  3146. * SELFAUTOLOC:                           Calling sequence.
  3147. * SELFAUTOPARENT:                        Calling sequence.
  3148. * sending patches:                       Bug checklist.
  3149. * setgid scripts:                        Security.
  3150. * sh5, ok with configure:                configure shells.
  3151. * shar, recommended:                     Bug checklist.
  3152. * shared library, making:                Shared library.
  3153. * shell scripts as configuration files:  Config files.
  3154. * shell variables:                       Variable expansion.
  3155. * shell_escape, example for code:        Programming with config files.
  3156. * shells and configure:                  configure shells.
  3157. * simple installation:                   Simple installation.
  3158. * site overrides for mktex...:           mktex configuration.
  3159. * size of distribution archives:         Disk space.
  3160. * skeleton TeX directory:                TeX directory structure.
  3161. * slow startup time:                     Slow path searching.
  3162. * Solaris BSD compatibility, not:        Running make.
  3163. * source files:                          Supported file formats.
  3164. * sources for search paths:              Path sources.
  3165. * special:                               Suppressing warnings.
  3166. * st_nlink:                              Subdirectory expansion.
  3167. * stack trace:                           Bug checklist.
  3168. * standalone path searching:             Invoking kpsewhich.
  3169. * standard error and debugging output:   Debugging.
  3170. * standard options:                      Standard options.
  3171. * startup time, excessive:               Slow path searching.
  3172. * static linking:                        ShellWidgetClass.
  3173. * static linking and dlsym:              dlopen.
  3174. * string routines:                       Calling sequence.
  3175. * strip:                                 mktex configuration.
  3176. * stripsupplier:                         mktex configuration.
  3177. * striptypeface:                         mktex configuration.
  3178. * subdirectory searching:                Subdirectory expansion.
  3179. * suggestions, making:                   Introduction.
  3180. * Sun 2:                                 History.
  3181. * Sun OpenWin patches:                   ShellWidgetClass.
  3182. * supplier directory, omitting:          mktex configuration.
  3183. * supported file formats:                Supported file formats.
  3184. * suppressing warnings:                  Suppressing warnings.
  3185. * symbolic link trees, for multiple architectures: configure scenarios.
  3186. * symbolic links not found:              Unable to find files.
  3187. * symbolic links, and ls-R:              ls-R.
  3188. * symlinks, resolving:                   Calling sequence.
  3189. * system C compiler bugs:                TeX or Metafont failing.
  3190. * system dependencies:                   Running configure.
  3191. * system V universe:                     Running make.
  3192. * T1FONTS:                               Supported file formats.
  3193. * T1INPUTS:                              Supported file formats.
  3194. * T42FONTS:                              Supported file formats.
  3195. * TDS:                                   TeX directory structure.
  3196. * testing, post-installation:            Installation testing.
  3197. * tests, simple:                         Simple installation.
  3198. * teTeX:                                 Other TeX packages.
  3199. * TeX directory structure:               TeX directory structure.
  3200. * TeX distributions besides Web2c:       Other TeX packages.
  3201. * TeX environment variables:             Supported file formats.
  3202. * TeX failures:                          TeX or Metafont failing.
  3203. * TeX file lookup:                       File lookup.
  3204. * TeX glyph lookup:                      Glyph lookup.
  3205. * TeX help mailing list:                 Mailing lists.
  3206. * TeX hierarchy, one:                    configure scenarios.
  3207. * TeX Live CD-ROM:                       CD-ROM distribution.
  3208. * TeX support:                           TeX support.
  3209. * TeX Users Group:                       Introduction.
  3210. * tex-archive@math.utah.edu:             Mailing lists.
  3211. * tex-file.c:                            File lookup.
  3212. * tex-file.h:                            Programming overview.
  3213. * tex-glyph.c:                           Glyph lookup.
  3214. * tex-glyph.h:                           Programming overview.
  3215. * tex-k-request@mail.tug.org:            Mailing lists.
  3216. * tex-k@mail.tug.org (bug address):      Reporting bugs.
  3217. * tex-make.c:                            mktex script names.
  3218. * TEX_HUSH <1>:                          Suppressing warnings.
  3219. * TEX_HUSH:                              Searching overview.
  3220. * TEXBIB:                                Supported file formats.
  3221. * TEXCONFIG:                             Supported file formats.
  3222. * TEXDOCS:                               Supported file formats.
  3223. * TEXFONTMAPS:                           Supported file formats.
  3224. * TEXFONTS:                              Supported file formats.
  3225. * texfonts.map:                          Fontmap.
  3226. * TEXFORMATS:                            Supported file formats.
  3227. * TEXINDEXSTYLE:                         Supported file formats.
  3228. * TEXINPUTS:                             Supported file formats.
  3229. * TEXMF:                                 TeX directory structure.
  3230. * texmf.cnf, and variable expansion:     Variable expansion.
  3231. * texmf.cnf, creating:                   Running make.
  3232. * texmf.cnf, definition for:             Config files.
  3233. * texmf.cnf, generated:                  Default path generation.
  3234. * texmf.cnf, source for path:            Path sources.
  3235. * texmf.in:                              Default path generation.
  3236. * texmf.in, editing:                     Changing search paths.
  3237. * texmf.sed:                             Default path generation.
  3238. * TEXMFCNF <1>:                          Supported file formats.
  3239. * TEXMFCNF:                              Config files.
  3240. * TEXMFDBS <1>:                          Supported file formats.
  3241. * TEXMFDBS:                              ls-R.
  3242. * TEXMFINI:                              Supported file formats.
  3243. * TEXMFLOG:                              Logging.
  3244. * TEXMFOUTPUT:                           mktex script names.
  3245. * TEXPICTS:                              Supported file formats.
  3246. * TEXPKS:                                Supported file formats.
  3247. * TEXPOOL:                               Supported file formats.
  3248. * TEXPSHEADERS:                          Supported file formats.
  3249. * TEXSIZES:                              Fallback font.
  3250. * TEXSOURCES:                            Supported file formats.
  3251. * TFMFONTS:                              Supported file formats.
  3252. * tilde expansion:                       Tilde expansion.
  3253. * tilde.c:                               Tilde expansion.
  3254. * time system call:                      Logging.
  3255. * tolerance for glyph lookup:            Basic glyph lookup.
  3256. * total disk space:                      Disk space.
  3257. * trailing / in home directory:          Tilde expansion.
  3258. * trailing colons:                       Default expansion.
  3259. * TRFONTS:                               Supported file formats.
  3260. * trick for detecting leaf directories:  Subdirectory expansion.
  3261. * trojan horse attack:                   Security.
  3262. * TTFONTS:                               Supported file formats.
  3263. * TUG:                                   CD-ROM distribution.
  3264. * tug.org:                               unixtex.ftp.
  3265. * tug@tug.org:                           Introduction.
  3266. * typeface directory, omitting:          mktex configuration.
  3267. * ucbinclude, avoiding:                  Running make.
  3268. * UKTUG:                                 CD-ROM distribution.
  3269. * Ultrix shells and configure:           configure shells.
  3270. * unable to find files:                  Unable to find files.
  3271. * unable to generate fonts:              Unable to generate fonts.
  3272. * uname:                                 Bug checklist.
  3273. * universe, BSD vs. system V:            Running make.
  3274. * UNIX_ST_LINK:                          Subdirectory expansion.
  3275. * unixtex.ftp:                           unixtex.ftp.
  3276. * unknown special warnings:              Suppressing warnings.
  3277. * unreadable file warnings:              Suppressing warnings.
  3278. * unreadable files:                      Searching overview.
  3279. * unusable ls-R warning:                 ls-R.
  3280. * usage patterns, finding:               Logging.
  3281. * USE_VARTEXFONTS:                       mktex configuration.
  3282. * Usenet TeX newsgroup:                  Mailing lists.
  3283. * varfonts:                              mktex configuration.
  3284. * variable expansion:                    Variable expansion.
  3285. * variable.c:                            Variable expansion.
  3286. * variable.h:                            Programming with config files.
  3287. * VARTEXFONTS:                           mktex configuration.
  3288. * VAX 11/750:                            History.
  3289. * version number, of Kpathsea:           Kpathsea application distributions.
  3290. * version numbers, determining:          Bug checklist.
  3291. * VF files, not found:                   Searching overview.
  3292. * VFFONTS:                               Supported file formats.
  3293. * VMS support:                           Custom installation.
  3294. * VMS TeX implementations:               Other TeX packages.
  3295. * Vojta, Paul:                           History.
  3296. * Walnut Creek TeX CD-ROM:               CD-ROM distribution.
  3297. * Walsh, Norman:                         History.
  3298. * warning about unusable ls-R:           ls-R.
  3299. * warnings, file access:                 Searching overview.
  3300. * warnings, pointer combinations:        Pointer combination warnings.
  3301. * warnings, suppressing:                 Suppressing warnings.
  3302. * wcstombs:                              dlopen.
  3303. * Weber, Olaf:                           History.
  3304. * whitespace, in fontmap files:          Fontmap.
  3305. * whitespace, not ignored on continuation lines: Config files.
  3306. * Windows TeX implementations:           Other TeX packages.
  3307. * World Wide Web CTAN access:            Electronic distribution.
  3308. * www.tug.org:                           unixtex.ftp.
  3309. * X11 previewer:                         Kpathsea application distributions.
  3310. * X11, lacking on NeXT:                  Kpathsea application distributions.
  3311. * XCFLAGS:                               Running make.
  3312. * XCPPFLAGS:                             Running make.
  3313. * XDEFS:                                 Running make.
  3314. * XDVIFONTS:                             Supported file formats.
  3315. * XDVIMAKEPK:                            mktex script names.
  3316. * XDVISIZES:                             Fallback font.
  3317. * XLDFLAGS:                              Running make.
  3318. * XLOADLIBES:                            Running make.
  3319. * XMAKEARGS:                             Running make.
  3320. * Xmu library problems:                  ShellWidgetClass.
  3321. * XtStrings:                             XtStrings.
  3322. * zuhn, david:                           History.
  3323. * { expansion:                           Brace expansion.
  3324. * ~ expansion:                           Tilde expansion.
  3325. Tag Table:
  3326. Node: Top
  3327. Node: Introduction
  3328. Node: History
  3329. Node: Installation
  3330. Node: Simple installation
  3331. Node: Custom installation
  3332. 12506
  3333. Node: Disk space
  3334. 13672
  3335. Node: Kpathsea application distributions
  3336. 14586
  3337. Node: Changing search paths
  3338. 15690
  3339. Node: Default path features
  3340. 16858
  3341. Node: Default path generation
  3342. 18974
  3343. Node: Running configure
  3344. 20401
  3345. Node: configure shells
  3346. 21441
  3347. Node: configure options
  3348. 22472
  3349. Node: configure environment
  3350. 23963
  3351. Node: configure scenarios
  3352. 25751
  3353. Node: Shared library
  3354. 27325
  3355. Node: Running make
  3356. 28642
  3357. Node: Installing files
  3358. 30674
  3359. Node: Cleaning up
  3360. 32609
  3361. Node: Filename database generation
  3362. 33644
  3363. Node: mktex scripts
  3364. 34198
  3365. Node: mktex configuration
  3366. 35145
  3367. Node: mktex script names
  3368. 40224
  3369. Node: mktex script arguments
  3370. 41305
  3371. Node: Installation testing
  3372. 42180
  3373. Node: Security
  3374. 42532
  3375. Node: TeX directory structure
  3376. 45085
  3377. Node: unixtex.ftp
  3378. 49500
  3379. Node: Electronic distribution
  3380. 51045
  3381. Node: CD-ROM distribution
  3382. 55130
  3383. Node: Other TeX packages
  3384. 57116
  3385. Node: Reporting bugs
  3386. 58407
  3387. Node: Bug checklist
  3388. 59142
  3389. Node: Mailing lists
  3390. 63232
  3391. Node: Debugging
  3392. 64577
  3393. Node: Logging
  3394. 69639
  3395. Node: Common problems
  3396. 71137
  3397. Node: Unable to find files
  3398. 71958
  3399. Node: Slow path searching
  3400. 74357
  3401. Node: Unable to generate fonts
  3402. 75720
  3403. Node: TeX or Metafont failing
  3404. 77265
  3405. Node: Empty Makefiles
  3406. 79124
  3407. Node: XtStrings
  3408. 80336
  3409. Node: dlopen
  3410. 81156
  3411. Node: ShellWidgetClass
  3412. 81958
  3413. Node: Pointer combination warnings
  3414. 83575
  3415. Node: Path searching
  3416. 83950
  3417. Node: Searching overview
  3418. 84595
  3419. Node: Path sources
  3420. 87954
  3421. Node: Config files
  3422. 89019
  3423. Node: Path expansion
  3424. 92512
  3425. Node: Default expansion
  3426. 93455
  3427. Node: Variable expansion
  3428. 95133
  3429. Node: Tilde expansion
  3430. 96522
  3431. Node: Brace expansion
  3432. 97406
  3433. Node: KPSE_DOT expansion
  3434. 98497
  3435. Node: Subdirectory expansion
  3436. 99000
  3437. Node: Filename database
  3438. 101331
  3439. Node: ls-R
  3440. 102637
  3441. Node: Filename aliases
  3442. 105514
  3443. Node: Database format
  3444. 106679
  3445. Node: Invoking kpsewhich
  3446. 107691
  3447. Node: Path searching options
  3448. 108558
  3449. Node: Auxiliary tasks
  3450. 112251
  3451. Node: Standard options
  3452. 113509
  3453. Node: TeX support
  3454. 113819
  3455. Node: Supported file formats
  3456. 115106
  3457. Node: File lookup
  3458. 121364
  3459. Node: Glyph lookup
  3460. 122648
  3461. Node: Basic glyph lookup
  3462. 123768
  3463. Node: Fontmap
  3464. 124635
  3465. Node: Fallback font
  3466. 127233
  3467. Node: Suppressing warnings
  3468. 128189
  3469. Node: Programming
  3470. 129246
  3471. Node: Programming overview
  3472. 129757
  3473. Node: Calling sequence
  3474. 131673
  3475. Node: Program-specific files
  3476. 136696
  3477. Node: Programming with config files
  3478. 137726
  3479. Node: Index
  3480. 139016
  3481. End Tag Table
  3482.